Package org.apache.maven.doxia.sink

Class SinkEventAttributeSet

  • All Implemented Interfaces:
    java.lang.Cloneable, javax.swing.text.AttributeSet, javax.swing.text.MutableAttributeSet, SinkEventAttributes
    public class SinkEventAttributeSet
extends java.lang.Object
implements SinkEventAttributes, java.lang.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

    • Field Detail

      • 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 Detail

      • 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​(java.lang.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​(javax.swing.text.AttributeSet attributes)
        Constructs a new SinkEventAttributeSet with the same attribute name-value mappings as in the specified AttributeSet.
        Parameters:
        attributes - the specified AttributeSet.

    • Method Detail

      • 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 javax.swing.text.AttributeSet
        Returns:
        a int.

      • isDefined

        public boolean isDefined​(java.lang.Object attrName)
        Specified by:
        isDefined in interface javax.swing.text.AttributeSet

      • isEqual

        public boolean isEqual​(javax.swing.text.AttributeSet attr)
        Specified by:
        isEqual in interface javax.swing.text.AttributeSet

      • copyAttributes

        public javax.swing.text.AttributeSet copyAttributes()
        Specified by:
        copyAttributes in interface javax.swing.text.AttributeSet
        Returns:
        a AttributeSet object.

      • getAttributeNames

        public java.util.Enumeration<java.lang.String> getAttributeNames()
        Specified by:
        getAttributeNames in interface javax.swing.text.AttributeSet
        Returns:
        a Enumeration object.

      • getAttribute

        public java.lang.Object getAttribute​(java.lang.Object key)
        Specified by:
        getAttribute in interface javax.swing.text.AttributeSet

      • containsAttribute

        public boolean containsAttribute​(java.lang.Object name,
                                 java.lang.Object value)
        Specified by:
        containsAttribute in interface javax.swing.text.AttributeSet

      • containsAttributes

        public boolean containsAttributes​(javax.swing.text.AttributeSet attributes)
        Specified by:
        containsAttributes in interface javax.swing.text.AttributeSet

      • addAttribute

        public void addAttribute​(java.lang.Object name,
                         java.lang.Object value)
        Adds an attribute with the given name and value.
        Specified by:
        addAttribute in interface javax.swing.text.MutableAttributeSet

      • addAttributes

        public void addAttributes​(javax.swing.text.AttributeSet attributes)
        Specified by:
        addAttributes in interface javax.swing.text.MutableAttributeSet

      • removeAttribute

        public void removeAttribute​(java.lang.Object name)
        Specified by:
        removeAttribute in interface javax.swing.text.MutableAttributeSet

      • removeAttributes

        public void removeAttributes​(java.util.Enumeration<?> names)
        Specified by:
        removeAttributes in interface javax.swing.text.MutableAttributeSet

      • removeAttributes

        public void removeAttributes​(javax.swing.text.AttributeSet attributes)
        Specified by:
        removeAttributes in interface javax.swing.text.MutableAttributeSet
        Parameters:
        attributes - a AttributeSet object.

      • getResolveParent

        public javax.swing.text.AttributeSet getResolveParent()
        Specified by:
        getResolveParent in interface javax.swing.text.AttributeSet
        Returns:
        a AttributeSet object.

      • setResolveParent

        public void setResolveParent​(javax.swing.text.AttributeSet parent)
        Specified by:
        setResolveParent in interface javax.swing.text.MutableAttributeSet

      • entrySet

        public java.util.Set<java.util.Map.Entry<java.lang.String,​java.lang.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 java.lang.Object clone()
        Overrides:
        clone in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object