Package org.apache.maven.doxia.sink

Class SinkEventAttributeSet

java.lang.Object

org.apache.maven.doxia.sink.SinkEventAttributeSet

All Implemented Interfaces:

Cloneable, AttributeSet, MutableAttributeSet, SinkEventAttributes

Direct Known Subclasses:

SinkEventAttributeSet

public class SinkEventAttributeSet
extends Object
implements SinkEventAttributes, Cloneable

Implementation of MutableAttributeSet using a LinkedHashMap.

Moved here from doxia-core in 2.2.0, so that attributes can be created without depending on Doxia internals. The deprecated org.apache.maven.doxia.sink.impl.SinkEventAttributeSet remains as a subclass of this class for binary compatibility, which means the constants declared here, and every attribute set Doxia itself creates, are instances of this class and no longer of that one.

Since:

1.1

Author:

ltheussl

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SinkEventAttributeSet.Semantics	Attribute sets for the semantic attribute.

Nested classes/interfaces inherited from interface javax.swing.text.AttributeSet

AttributeSet.CharacterAttribute, AttributeSet.ColorAttribute, AttributeSet.FontAttribute, AttributeSet.ParagraphAttribute

Field Summary

Fields

Modifier and Type	Field	Description
static final SinkEventAttributes	BOLD	An unmodifiable attribute set containing only a bold attribute.
static final SinkEventAttributes	CENTER	An unmodifiable attribute set containing only a center attribute.
static final SinkEventAttributes	ITALIC	An unmodifiable attribute set containing only an italic attribute.
static final SinkEventAttributes	JUSTIFY	An unmodifiable attribute set containing only a justify attribute.
static final SinkEventAttributes	LEFT	An unmodifiable attribute set containing only a left attribute.
static final SinkEventAttributes	LINETHROUGH	An unmodifiable attribute set containing only a linethrough attribute.
static final SinkEventAttributes	MONOSPACED	An unmodifiable attribute set containing only a monospaced attribute.
static final SinkEventAttributes	OVERLINE	An unmodifiable attribute set containing only an overline attribute.
static final SinkEventAttributes	RIGHT	An unmodifiable attribute set containing only a right attribute.
static final SinkEventAttributes	SOURCE	An unmodifiable attribute set containing only a source attribute.
static final SinkEventAttributes	UNDERLINE	An unmodifiable attribute set containing only an underline attribute.

Fields inherited from interface javax.swing.text.AttributeSet

NameAttribute, ResolveAttribute

Fields inherited from interface org.apache.maven.doxia.sink.SinkEventAttributes

ABBRV, ALIGN, ALT, AXIS, BGCOLOR, BORDER, CELLPADDING, CELLSPACING, CHARSET, CLASS, COLSPAN, CONTENT, COORDS, DATETIME, DECORATION, EMAIL, FRAME, HEADERS, HEIGHT, HREF, HREFLANG, HSPACE, ID, ISMAP, LANG, NAME, NOSHADE, NOWRAP, PROFILE, REL, REV, ROWSPAN, RULES, SCOPE, SECTIONS, SEMANTICS, SHAPE, SIZE, SRC, STYLE, SUMMARY, TARGET, TITLE, TYPE, USEMAP, VALIGN, VALUE, VSPACE, WIDTH

Constructor Summary

Constructors

Constructor	Description
SinkEventAttributeSet()	Constructs a new, empty SinkEventAttributeSet with default size 5.
SinkEventAttributeSet(int size)	Constructs a new, empty SinkEventAttributeSet with the specified initial size.
SinkEventAttributeSet(String... attributes)	Constructs a new SinkEventAttributeSet with the attribute name-value mappings as given by the specified String array.
SinkEventAttributeSet(AttributeSet attributes)	Constructs a new SinkEventAttributeSet with the same attribute name-value mappings as in the specified AttributeSet.

Method Summary

Modifier and Type	Method	Description
void	addAttribute(Object name, Object value)	Adds an attribute with the given name and value.
void	addAttributes(AttributeSet attributes)
Object	clone()
boolean	containsAttribute(Object name, Object value)
boolean	containsAttributes(AttributeSet attributes)
AttributeSet	copyAttributes()
Set<Map.Entry<String,Object>>	entrySet()	Returns a Set view of the attributes in form of Map.Entry items.
boolean	equals(Object obj)
Object	getAttribute(Object key)
int	getAttributeCount()
Enumeration<String>	getAttributeNames()
AttributeSet	getResolveParent()
int	hashCode()
boolean	isDefined(Object attrName)
boolean	isEmpty()	Checks whether the set of attribs is empty.
boolean	isEqual(AttributeSet attr)
void	removeAttribute(Object name)
void	removeAttributes(Enumeration<?> names)
void	removeAttributes(AttributeSet attributes)
void	setResolveParent(AttributeSet parent)
String	toString()
SinkEventAttributeSet	unmodifiable()	Replace this AttributeSet by an unmodifiable view of itself.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

UNDERLINE

public static final SinkEventAttributes UNDERLINE

An unmodifiable attribute set containing only an underline attribute.

OVERLINE

public static final SinkEventAttributes OVERLINE

An unmodifiable attribute set containing only an overline attribute.

LINETHROUGH

public static final SinkEventAttributes LINETHROUGH

An unmodifiable attribute set containing only a linethrough attribute.

SOURCE

public static final SinkEventAttributes SOURCE

An unmodifiable attribute set containing only a source attribute.

BOLD

public static final SinkEventAttributes BOLD

An unmodifiable attribute set containing only a bold attribute.

ITALIC

public static final SinkEventAttributes ITALIC

An unmodifiable attribute set containing only an italic attribute.

MONOSPACED

public static final SinkEventAttributes MONOSPACED

An unmodifiable attribute set containing only a monospaced attribute.

LEFT

public static final SinkEventAttributes LEFT

An unmodifiable attribute set containing only a left attribute.

RIGHT

public static final SinkEventAttributes RIGHT

An unmodifiable attribute set containing only a right attribute.

CENTER

public static final SinkEventAttributes CENTER

An unmodifiable attribute set containing only a center attribute.

JUSTIFY

public static final SinkEventAttributes JUSTIFY

An unmodifiable attribute set containing only a justify attribute.

Constructor Details

SinkEventAttributeSet

public SinkEventAttributeSet()

Constructs a new, empty SinkEventAttributeSet with default size 5.

SinkEventAttributeSet

public SinkEventAttributeSet(int size)

Constructs a new, empty SinkEventAttributeSet with the specified initial size.

Parameters:

size - the initial number of attribs.

SinkEventAttributeSet

public SinkEventAttributeSet(String... attributes)

Constructs a new SinkEventAttributeSet with the attribute name-value mappings as given by the specified String array. Each even index of the array is an attribute name, and the following odd index is the corresponding attribute value. This constructor only supports String attribute values.

Parameters:

attributes - the specified String array. If the length of this array is not an even number, an IllegalArgumentException is thrown.

SinkEventAttributeSet

public SinkEventAttributeSet(AttributeSet attributes)

Constructs a new SinkEventAttributeSet with the same attribute name-value mappings as in the specified AttributeSet.

Parameters:

attributes - the specified AttributeSet.

Method Details

unmodifiable

public SinkEventAttributeSet unmodifiable()

Replace this AttributeSet by an unmodifiable view of itself. Any subsequent attempt to add, remove or modify the underlying mapping will result in an UnsupportedOperationException.

Returns:

an unmodifiable view of this AttributeSet.

Since:

1.1.1

isEmpty

public boolean isEmpty()

Checks whether the set of attribs is empty.

Returns:

true if the set is empty.

getAttributeCount

public int getAttributeCount()

Specified by:

getAttributeCount in interface AttributeSet

Returns:

a int.

isDefined

public boolean isDefined(Object attrName)

Specified by:

isDefined in interface AttributeSet

isEqual

public boolean isEqual(AttributeSet attr)

Specified by:

isEqual in interface AttributeSet

copyAttributes

public AttributeSet copyAttributes()

Specified by:

copyAttributes in interface AttributeSet

Returns:

a AttributeSet object.

getAttributeNames

public Enumeration<String> getAttributeNames()

Specified by:

getAttributeNames in interface AttributeSet

Returns:

a Enumeration object.

getAttribute

public Object getAttribute(Object key)

Specified by:

getAttribute in interface AttributeSet

containsAttribute

public boolean containsAttribute(Object name,
 Object value)

Specified by:

containsAttribute in interface AttributeSet

containsAttributes

public boolean containsAttributes(AttributeSet attributes)

Specified by:

containsAttributes in interface AttributeSet

addAttribute

public void addAttribute(Object name,
 Object value)

Adds an attribute with the given name and value.

Specified by:

addAttribute in interface MutableAttributeSet

addAttributes

public void addAttributes(AttributeSet attributes)

Specified by:

addAttributes in interface MutableAttributeSet

removeAttribute

public void removeAttribute(Object name)

Specified by:

removeAttribute in interface MutableAttributeSet

removeAttributes

public void removeAttributes(Enumeration<?> names)

Specified by:

removeAttributes in interface MutableAttributeSet

removeAttributes

public void removeAttributes(AttributeSet attributes)

Specified by:

removeAttributes in interface MutableAttributeSet

Parameters:

attributes - a AttributeSet object.

getResolveParent

public AttributeSet getResolveParent()

Specified by:

getResolveParent in interface AttributeSet

Returns:

a AttributeSet object.

setResolveParent

public void setResolveParent(AttributeSet parent)

Specified by:

setResolveParent in interface MutableAttributeSet

entrySet

public Set<Map.Entry<String,Object>> entrySet()

Description copied from interface: SinkEventAttributes

Returns a Set view of the attributes in form of Map.Entry items. The set is backed by the underlying map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Specified by:

entrySet in interface SinkEventAttributes

Returns:

a set view of the attributes

clone

public Object clone()

Overrides:

clone in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object