edu.utexas.its.eis.tools.qwicap.template.xml.structure
Interface Attribute

All Superinterfaces:
Cloneable, Item, NamedItem, Range

public interface Attribute
extends NamedItem

Common interface to all classes representing the attributes of tags and XML declarations (for example: "id='thing'") in XML documents.

Author:
Chris W. Johnson

Method Summary
 StringBuffer append(StringBuffer Buff)
          Appends this attribute to the specified StringBuffer.
 StringBuilder append(StringBuilder Buff)
          Appends this attribute to the specified StringBuilder.
 Characters getValue()
          Returns the value of this attribute.
 boolean valueEquals(Characters Other)
          Tests the value of this attribute for equality with the specified characters.
 boolean valueIncludes(Characters Other)
          Assumes that the value of this attribute is a whitespace-separated list of values, and determines whether the specified value is present in that list of values.
 boolean valueStartsWith(Characters Other)
          Assumes that the value of this attribute, and the supplied set of characters, are both hyphen ('-') separated lists of values, and determines whether the specified set of values matches the values at the start of this attribute's list.
 
Methods inherited from interface edu.utexas.its.eis.tools.qwicap.template.xml.structure.NamedItem
getName, getNamespace, getNameString, nameEquals, nameEquals
 
Methods inherited from interface edu.utexas.its.eis.tools.qwicap.template.xml.structure.Item
contentEquals, getContent
 
Methods inherited from interface edu.utexas.its.eis.tools.qwicap.template.xml.structure.Range
clone, isEmptyTag, isEndTag, isStartTag, isTagWithAttributes, rangeEquals, toString, write
 

Method Detail

valueEquals

boolean valueEquals(Characters Other)
Tests the value of this attribute for equality with the specified characters. The comparison is sensitive to case.

Parameters:
Other - The set of characters to be tested for equality with the value of this attribute.
Returns:
true if the value of this attribute and the specified set of characters are equal, false otherwise.

valueIncludes

boolean valueIncludes(Characters Other)
Assumes that the value of this attribute is a whitespace-separated list of values, and determines whether the specified value is present in that list of values. The comparison is sensitive to case.

Parameters:
Other - The value to be searched for among the whitespace-separated list of values that make-up the value of this attribute.
Returns:
true if the specified value is present in the list of values that make-up the value of this attribute, false otherwise.

valueStartsWith

boolean valueStartsWith(Characters Other)
Assumes that the value of this attribute, and the supplied set of characters, are both hyphen ('-') separated lists of values, and determines whether the specified set of values matches the values at the start of this attribute's list. A value in the list is considered to be matched only if it is completely matched by a corresponding value in the supplied set of characters. The supplied set of characters must not end with a hyphen. The comparison is sensitive to case.

Parameters:
Other - The set of hyphen-separated values to be tested for equality with the initial hyphen-separated values of this attribute. The characters of this parameter must not end with a hyphen.
Returns:
true if the hyphen-separated values at the start of this attribute's value match the specified set hyphen-separated values, false otherwise.

getValue

Characters getValue()
Returns the value of this attribute.

Returns:
The value of this attribute.

append

StringBuffer append(StringBuffer Buff)
Appends this attribute to the specified StringBuffer.

Parameters:
Buff - The buffer to which this attribute should be appended.
Returns:
The buffer specified by the Buff parameter.

append

StringBuilder append(StringBuilder Buff)
Appends this attribute to the specified StringBuilder.

Parameters:
Buff - The buffer to which this attribute should be appended.
Returns:
The buffer specified by the Buff parameter.