Package org.jsoup.nodes
Class Attribute
- java.lang.Object
-
- org.jsoup.nodes.Attribute
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Attribute
clone()
static Attribute
createFromEncoded(String unencodedKey, String encodedValue)
Create a new Attribute from an unencoded key and a HTML attribute encoded value.boolean
equals(Object o)
String
getKey()
Get the attribute key.String
getValue()
Get the attribute value.boolean
hasDeclaredValue()
Check if this Attribute has a value.int
hashCode()
String
html()
Get the HTML representation of this attribute; e.g.protected void
html(Appendable accum, Document.OutputSettings out)
protected static void
html(String key, String val, Appendable accum, Document.OutputSettings out)
protected static boolean
isBooleanAttribute(String key)
Checks if this attribute name is defined as a boolean attribute in HTML5protected boolean
isDataAttribute()
protected static boolean
isDataAttribute(String key)
void
setKey(String key)
Set the attribute key; case is preserved.String
setValue(String val)
Set the attribute value.protected static boolean
shouldCollapseAttribute(String key, String val, Document.OutputSettings out)
protected boolean
shouldCollapseAttribute(Document.OutputSettings out)
Collapsible if it's a boolean attribute and value is empty or same as nameString
toString()
Get the string representation of this attribute, implemented ashtml()
.
-
-
-
Constructor Detail
-
Attribute
public Attribute(String key, String value)
Create a new attribute from unencoded (raw) key and value.- Parameters:
key
- attribute key; case is preserved.value
- attribute value (may be null)- See Also:
createFromEncoded(java.lang.String, java.lang.String)
-
Attribute
public Attribute(String key, String val, Attributes parent)
Create a new attribute from unencoded (raw) key and value.- Parameters:
key
- attribute key; case is preserved.val
- attribute valueparent
- the containing Attributes (this Attribute is not automatically added to said Attributes)- See Also:
createFromEncoded(java.lang.String, java.lang.String)
-
-
Method Detail
-
getKey
public String getKey()
Get the attribute key.
-
setKey
public void setKey(String key)
Set the attribute key; case is preserved.- Parameters:
key
- the new key; must not be null
-
getValue
public String getValue()
Get the attribute value. Will return an empty string if the value is not set.
-
hasDeclaredValue
public boolean hasDeclaredValue()
Check if this Attribute has a value. Set boolean attributes have no value.- Returns:
- if this is a boolean attribute / attribute without a value
-
html
public String html()
Get the HTML representation of this attribute; e.g.href="index.html"
.- Returns:
- HTML
-
html
protected static void html(String key, String val, Appendable accum, Document.OutputSettings out) throws IOException
- Throws:
IOException
-
html
protected void html(Appendable accum, Document.OutputSettings out) throws IOException
- Throws:
IOException
-
toString
public String toString()
Get the string representation of this attribute, implemented ashtml()
.
-
createFromEncoded
public static Attribute createFromEncoded(String unencodedKey, String encodedValue)
Create a new Attribute from an unencoded key and a HTML attribute encoded value.- Parameters:
unencodedKey
- assumes the key is not encoded, as can be only run of simple \w chars.encodedValue
- HTML attribute encoded value- Returns:
- attribute
-
isDataAttribute
protected boolean isDataAttribute()
-
isDataAttribute
protected static boolean isDataAttribute(String key)
-
shouldCollapseAttribute
protected final boolean shouldCollapseAttribute(Document.OutputSettings out)
Collapsible if it's a boolean attribute and value is empty or same as name- Parameters:
out
- output settings- Returns:
- Returns whether collapsible or not
-
shouldCollapseAttribute
protected static boolean shouldCollapseAttribute(String key, String val, Document.OutputSettings out)
-
isBooleanAttribute
protected static boolean isBooleanAttribute(String key)
Checks if this attribute name is defined as a boolean attribute in HTML5
-
equals
public boolean equals(Object o)
-
hashCode
public int hashCode()
-
-