Module org.tquadrat.foundation.xml

Package org.tquadrat.foundation.xml.parse

Record Class Attribute

java.lang.Object

java.lang.Record

org.tquadrat.foundation.xml.parse.Attribute

Record Components:

qName - The XML qualified (prefixed) name for the attribute.

localName - An instance of Optional that holds the local name for the attribute; will be empty if Namespace processing is not being performed.

uri - An instance Optional that holds the Namespace URI for the attribute; will be empty if none is available.

type - The attribute type. If the parser has not read a declaration for the attribute, or if the parser does not report attribute types, then it must return the value CDATA as stated in the XML 1.0 Recommendation (clause 3.3.3, "Attribute-Value Normalization"). For an enumerated attribute that is not a notation (NOTATION), the parser will report the type as NMTOKEN.

value - The value of the attribute.

index - The index of the attribute in the attributes list for the element.

@ClassVersion(sourceVersion="$Id: Attribute.java 1030 2022-04-06 13:42:02Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
public record Attribute(String qName, Optional<String> localName, Optional<URI> uri, Attribute.Type type, String value, int index)
extends Record

An attribute.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: Attribute.java 1030 2022-04-06 13:42:02Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.xml.parse.Attribute"

⁠

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Attribute.Type	The attribute types.

Field Summary

Fields

Modifier and Type	Field	Description
private final int	index	The field for the index record component.
private final Optional<String>	localName	The field for the localName record component.
private final String	qName	The field for the qName record component.
private final Attribute.Type	type	The field for the type record component.
private final Optional<URI>	uri	The field for the uri record component.
private final String	value	The field for the value record component.

Constructor Summary

Constructors

Constructor	Description
Attribute(String qName, Optional<String> localName, Optional<URI> uri, Attribute.Type type, String value, int index)	Creates an instance of a Attribute record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Collection<String>	getEntities()	If the attribute is of type Attribute.Type.ENTITY or Attribute.Type.ENTITIES, this method will return a list of the entity values.
Collection<String>	getIDReferences()	If the attribute is of type Attribute.Type.IDREF or Attribute.Type.IDREFS, this method will return a list of the ID references.
Collection<String>	getNameTokens()	If the attribute is of type Attribute.Type.NMTOKEN or Attribute.Type.NMTOKENS, this method will return a list of the name tokens.
final int	hashCode()	Returns a hash code value for this object.
int	index()	Returns the value of the index record component.
Optional<String>	localName()	Returns the value of the localName record component.
String	qName()	Returns the value of the qName record component.
final String	toString()	Returns a string representation of this record class.
Attribute.Type	type()	Returns the value of the type record component.
Optional<URI>	uri()	Returns the value of the uri record component.
String	value()	Returns the value of the value record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

qName

private final String qName

The field for the qName record component.

localName

private final Optional<String> localName

The field for the localName record component.

uri

private final Optional<URI> uri

The field for the uri record component.

type

private final Attribute.Type type

The field for the type record component.

value

private final String value

The field for the value record component.

index

private final int index

The field for the index record component.

Constructor Details

Attribute

public Attribute(String qName,
 Optional<String> localName,
 Optional<URI> uri,
 Attribute.Type type,
 String value,
 int index)

Creates an instance of a Attribute record class.

Parameters:

qName - the value for the qName record component

localName - the value for the localName record component

uri - the value for the uri record component

type - the value for the type record component

value - the value for the value record component

index - the value for the index record component

Method Details

getEntities

public Collection<String> getEntities()

If the attribute is of type Attribute.Type.ENTITY or Attribute.Type.ENTITIES, this method will return a list of the entity values.

Returns:

The entity values; the return value is empty, if the attribute is not of type Attribute.Type.ENTITY or Attribute.Type.ENTITIES.

getIDReferences

public Collection<String> getIDReferences()

If the attribute is of type Attribute.Type.IDREF or Attribute.Type.IDREFS, this method will return a list of the ID references.

Returns:

The ID references; the return value is empty, if the attribute is not of type Attribute.Type.IDREF or Attribute.Type.IDREFS.

getNameTokens

public Collection<String> getNameTokens()

If the attribute is of type Attribute.Type.NMTOKEN or Attribute.Type.NMTOKENS, this method will return a list of the name tokens.

Returns:

The name tokens; the return value is empty, if the attribute is not of type Attribute.Type.NMTOKEN or Attribute.Type.NMTOKENS,

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

qName

public String qName()

Returns the value of the qName record component.

Returns:

the value of the qName record component

localName

public Optional<String> localName()

Returns the value of the localName record component.

Returns:

the value of the localName record component

uri

public Optional<URI> uri()

Returns the value of the uri record component.

Returns:

the value of the uri record component

type

public Attribute.Type type()

Returns the value of the type record component.

Returns:

the value of the type record component

value

public String value()

Returns the value of the value record component.

Returns:

the value of the value record component

index

public int index()

Returns the value of the index record component.

Returns:

the value of the index record component