public class Attributes extends Object implements Iterable<Attribute>, Cloneable
Attributes are treated as a map: there can be only one value associated with an attribute key/name.
Attribute name and value comparisons are case sensitive. By default for HTML, attribute names are normalized to lower-case on parsing. That means you should use lower-case strings when referring to attributes by name.
Modifier and Type | Field and Description |
---|---|
protected static String |
dataPrefix |
Constructor and Description |
---|
Attributes() |
Modifier and Type | Method and Description |
---|---|
void |
addAll(Attributes incoming)
Add all the attributes from the incoming set to this set.
|
List<Attribute> |
asList()
Get the attributes as a List, for iteration.
|
Attributes |
clone() |
Map<String,String> |
dataset()
Retrieves a filtered view of attributes that are HTML5 custom data attributes; that is, attributes with keys
starting with
data- . |
boolean |
equals(Object o)
Checks if these attributes are equal to another set of attributes, by comparing the two sets
|
String |
get(String key)
Get an attribute value by key.
|
String |
getIgnoreCase(String key)
Get an attribute's value by case-insensitive key
|
int |
hashCode()
Calculates the hashcode of these attributes, by iterating all attributes and summing their hashcodes.
|
boolean |
hasKey(String key)
Tests if these attributes contain an attribute with this key.
|
boolean |
hasKeyIgnoreCase(String key)
Tests if these attributes contain an attribute with this key.
|
String |
html()
Get the HTML representation of these attributes.
|
Iterator<Attribute> |
iterator() |
void |
put(Attribute attribute)
Set a new attribute, or replace an existing one by key.
|
void |
put(String key,
boolean value)
Set a new boolean attribute, remove attribute if value is false.
|
void |
put(String key,
String value)
Set a new attribute, or replace an existing one by key.
|
void |
remove(String key)
Remove an attribute by key.
|
void |
removeIgnoreCase(String key)
Remove an attribute by key.
|
int |
size()
Get the number of attributes in this set.
|
String |
toString() |
finalize, getClass, notify, notifyAll, wait, wait, wait
forEach, spliterator
protected static final String dataPrefix
public String get(String key)
key
- the (case-sensitive) attribute keyhasKey(String)
public String getIgnoreCase(String key)
key
- the attribute namepublic void put(String key, String value)
key
- attribute keyvalue
- attribute valuepublic void put(String key, boolean value)
key
- attribute keyvalue
- attribute valuepublic void put(Attribute attribute)
attribute
- attributepublic void remove(String key)
key
- attribute key to removepublic void removeIgnoreCase(String key)
key
- attribute key to removepublic boolean hasKey(String key)
key
- case-sensitive key to check forpublic boolean hasKeyIgnoreCase(String key)
key
- key to check forpublic int size()
public void addAll(Attributes incoming)
incoming
- attributes to add to these attributes.public List<Attribute> asList()
public Map<String,String> dataset()
data-
.public String html()
SerializationException
- if the HTML representation of the attributes cannot be constructed.public boolean equals(Object o)
public int hashCode()
public Attributes clone()
Copyright © 2017. All rights reserved.