org.apache.maven.doxia.sink
Class SinkUtils

java.lang.Object
  org.apache.maven.doxia.sink.SinkUtils

public class SinkUtils
extends Object

Collection of common utility methods for sinks.

Since:

1.1

Version:

$Id: SinkUtils.java 1185112 2011-10-17 11:33:00Z ltheussl $

Author:

ltheussl

Field Summary

static String[]	SINK_BASE_ATTRIBUTES The set of base attributes.
static String[]	SINK_BR_ATTRIBUTES The attributes that are supported for the br tag.
static String[]	SINK_HR_ATTRIBUTES The attributes that are supported for the <hr> tag.
static String[]	SINK_IMG_ATTRIBUTES The attributes that are supported for the <img> tag.
static String[]	SINK_LINK_ATTRIBUTES The attributes that are supported for the <a> tag.
static String[]	SINK_SECTION_ATTRIBUTES The attributes that are supported for the section tags, like <p>, <h2>, <div>.
static String[]	SINK_TABLE_ATTRIBUTES The attributes that are supported for the <table> tag.
static String[]	SINK_TD_ATTRIBUTES The attributes that are supported for the <td> and <th> tags.
static String[]	SINK_TR_ATTRIBUTES The attributes that are supported for the <tr> tag.
static String[]	SINK_VERBATIM_ATTRIBUTES The attributes that are supported for the <div> and <pre> tags.

Method Summary

static MutableAttributeSet	filterAttributes(AttributeSet attributes, String[] valids) Filters the given AttributeSet.
static String	getAttributeString(AttributeSet att) Utility method to get an AttributeSet as a String.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SINK_BASE_ATTRIBUTES

public static final String[] SINK_BASE_ATTRIBUTES

The set of base attributes.

SINK_BR_ATTRIBUTES

public static final String[] SINK_BR_ATTRIBUTES

The attributes that are supported for the br tag.

SINK_IMG_ATTRIBUTES

public static final String[] SINK_IMG_ATTRIBUTES

The attributes that are supported for the <img> tag.

SINK_SECTION_ATTRIBUTES

public static final String[] SINK_SECTION_ATTRIBUTES

The attributes that are supported for the section tags, like <p>, <h2>, <div>.

SINK_VERBATIM_ATTRIBUTES

public static final String[] SINK_VERBATIM_ATTRIBUTES

The attributes that are supported for the <div> and <pre> tags.

SINK_HR_ATTRIBUTES

public static final String[] SINK_HR_ATTRIBUTES

The attributes that are supported for the <hr> tag.

SINK_LINK_ATTRIBUTES

public static final String[] SINK_LINK_ATTRIBUTES

The attributes that are supported for the <a> tag.

SINK_TABLE_ATTRIBUTES

public static final String[] SINK_TABLE_ATTRIBUTES

The attributes that are supported for the <table> tag.

SINK_TD_ATTRIBUTES

public static final String[] SINK_TD_ATTRIBUTES

The attributes that are supported for the <td> and <th> tags.

SINK_TR_ATTRIBUTES

public static final String[] SINK_TR_ATTRIBUTES

The attributes that are supported for the <tr> tag.

Method Detail

getAttributeString

public static String getAttributeString(AttributeSet att)

Utility method to get an AttributeSet as a String. The resulting String is in the form ' name1="value1" name2="value2" ...', ie it can be appended directly to an xml start tag. Attribute values that are itself AttributeSets are ignored unless the Attribute name is SinkEventAttributeSet.STYLE, in which case they are written as outlined at SinkEventAttributes.STYLE. All other keys and values are written as Strings.

Parameters:

att - The AttributeSet. May be null, in which case an empty String is returned.

Returns:

the AttributeSet as a String in a form that can be appended to an xml start tag.

filterAttributes

public static MutableAttributeSet filterAttributes(AttributeSet attributes,
                                                   String[] valids)

Filters the given AttributeSet. Removes all attributes whose name (key) is not contained in the sorted array valids.

Parameters:

attributes - The AttributeSet to filter. The String values of Attribute names are compared to the elements of the valids array.

valids - a sorted array of attribute names that are to be kept in the resulting AttributeSet. Note: a binary search is employed, so the array has to be sorted for correct results.

Returns:

A filtered MutableAttributeSet object. Returns null if the input AttributeSet is null. If the array of valids is either null or empty, an empty AttributeSet is returned.