Interface Attribute
-
- All Superinterfaces:
com.vladsch.flexmark.util.misc.Immutable<Attribute,MutableAttribute>
- All Known Subinterfaces:
MutableAttribute
- All Known Implementing Classes:
AttributeImpl
,MutableAttributeImpl
public interface Attribute extends com.vladsch.flexmark.util.misc.Immutable<Attribute,MutableAttribute>
-
-
Field Summary
Fields Modifier and Type Field Description static String
CLASS_ATTR
static String
ID_ATTR
static String
LINK_STATUS_ATTR
static String
NAME_ATTR
static Attribute
NO_FOLLOW
static Set<String>
NON_RENDERING_WHEN_EMPTY
static char
NUL
Deprecated.static String
STYLE_ATTR
static String
TARGET_ATTR
static String
TITLE_ATTR
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
containsValue(CharSequence value)
See if the attribute contains the value (if attribute has list delimiter set) or is equal to the value if no list delimiter is setString
getName()
String
getValue()
char
getValueListDelimiter()
char
getValueNameDelimiter()
boolean
isNonRendering()
Attribute
removeValue(CharSequence value)
Add a new value or values depending on list and name delimiter settings and value content.Attribute
replaceValue(CharSequence value)
Replace the complete value of this attribute by a new valueAttribute
setValue(CharSequence value)
Add a new value or values depending on list and name delimiter settings and value content
-
-
-
Field Detail
-
CLASS_ATTR
static final String CLASS_ATTR
- See Also:
- Constant Field Values
-
ID_ATTR
static final String ID_ATTR
- See Also:
- Constant Field Values
-
LINK_STATUS_ATTR
static final String LINK_STATUS_ATTR
- See Also:
- Constant Field Values
-
NAME_ATTR
static final String NAME_ATTR
- See Also:
- Constant Field Values
-
STYLE_ATTR
static final String STYLE_ATTR
- See Also:
- Constant Field Values
-
TITLE_ATTR
static final String TITLE_ATTR
- See Also:
- Constant Field Values
-
TARGET_ATTR
static final String TARGET_ATTR
- See Also:
- Constant Field Values
-
NO_FOLLOW
static final Attribute NO_FOLLOW
-
NUL
@Deprecated static final char NUL
Deprecated.- See Also:
- Constant Field Values
-
-
Method Detail
-
getName
String getName()
-
getValue
String getValue()
-
getValueListDelimiter
char getValueListDelimiter()
-
getValueNameDelimiter
char getValueNameDelimiter()
-
isNonRendering
boolean isNonRendering()
-
containsValue
boolean containsValue(CharSequence value)
See if the attribute contains the value (if attribute has list delimiter set) or is equal to the value if no list delimiter is set- Parameters:
value
- name part of the attribute value list or the value if the attribute does not have a value list delimiter- Returns:
- true if the attribute contains the valueName
-
replaceValue
Attribute replaceValue(CharSequence value)
Replace the complete value of this attribute by a new value- Parameters:
value
- new value- Returns:
- new attribute or same attribute if nothing changed or attribute is mutable
-
setValue
Attribute setValue(CharSequence value)
Add a new value or values depending on list and name delimiter settings and value contentIf the attribute does not have a list delimiter then its value will be set to the given value.
If the attribute has a list delimiter but not name delimiter then value will be split by list delimiter and all values will be added to the attribute's value list. New ones added at the end, old ones left as is.
If the attribute has a list delimiter and a name delimiter then value will be split by list delimiter and the name portion of each value will be used to find duplicates whose value will be replaced. New ones added at the end, old ones left where they are but with a new value.
- Parameters:
value
- value or list of values (if attribute has a list delimiter and name delimiter) to change- Returns:
- new attribute or same attribute if nothing changed or attribute is mutable
-
removeValue
Attribute removeValue(CharSequence value)
Add a new value or values depending on list and name delimiter settings and value content.If the attribute does not have a list delimiter and its value is equal to the given value then its value is set to empty
If the attribute has a list delimiter but not name delimiter then value will be split by list delimiter and any values in attribute's value list will be removed
If the attribute has a list delimiter and a name delimiter then value will be split by list delimiter and only the name portion of each value will be used for removal from the attribute's value list
- Parameters:
value
- value or list of values (if attribute has a list delimiter and name delimiter) to remove- Returns:
- new attribute or same attribute if nothing changed or attribute is mutable
-
-