Record Class SchemaSignature.Position

java.lang.Object

java.lang.Record

network.ike.plugin.schema.SchemaSignature.Position

Record Components:

name - the position's name as the schema spells it, operand

kind - element or attribute

valueType - the type of value the position holds

minimum - the fewest values allowed, 0 for optional

maximum - the most values allowed, or UNBOUNDED

documentation - the schema's own description of this position on this type, empty when the schema gives none

Enclosing class:

SchemaSignature

public static record SchemaSignature.Position(String name, SchemaSignature.PositionKind kind, SchemaSignature.TypeReference valueType, int minimum, int maximum, String documentation)
extends Record

One argument position of a type: a child element or an attribute, with the type of value it holds and how many of them the schema allows.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	UNBOUNDED	The maximum recorded for a position the schema leaves unbounded.

Constructor Summary

Constructors

Constructor	Description
Position(String name, SchemaSignature.PositionKind kind, SchemaSignature.TypeReference valueType, int minimum, int maximum, String documentation)	Creates an instance of a Position record class.

Method Summary

Modifier and Type	Method	Description
String	documentation()	Returns the value of the documentation record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
SchemaSignature.PositionKind	kind()	Returns the value of the kind record component.
int	maximum()	Returns the value of the maximum record component.
int	minimum()	Returns the value of the minimum record component.
String	name()	Returns the value of the name record component.
final String	toString()	Returns a string representation of this record class.
SchemaSignature.TypeReference	valueType()	Returns the value of the valueType record component.

Methods inherited from class Object

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

Field Details

UNBOUNDED

public static final int UNBOUNDED

The maximum recorded for a position the schema leaves unbounded.

See Also:

• Constant Field Values

Constructor Details

Position

public Position(String name,
 SchemaSignature.PositionKind kind,
 SchemaSignature.TypeReference valueType,
 int minimum,
 int maximum,
 String documentation)

Creates an instance of a Position record class.

Parameters:

name - the value for the name record component

kind - the value for the kind record component

valueType - the value for the valueType record component

minimum - the value for the minimum record component

maximum - the value for the maximum record component

documentation - the value for the documentation record component

Method Details

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 the compare method from their corresponding wrapper classes.

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.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

kind

public SchemaSignature.PositionKind kind()

Returns the value of the kind record component.

Returns:

the value of the kind record component

valueType

public SchemaSignature.TypeReference valueType()

Returns the value of the valueType record component.

Returns:

the value of the valueType record component

minimum

public int minimum()

Returns the value of the minimum record component.

Returns:

the value of the minimum record component

maximum

public int maximum()

Returns the value of the maximum record component.

Returns:

the value of the maximum record component

documentation

public String documentation()

Returns the value of the documentation record component.

Returns:

the value of the documentation record component