Record Class ArrayElement

java.lang.Object

java.lang.Record

eu.cloudnetservice.driver.document.send.element.ArrayElement

Record Components:

key - the key of this element or Element.NO_KEY if an array entry.

entries - the entries of the array element.

All Implemented Interfaces:

Element

public record ArrayElement(@NonNull String key, @NonNull @Unmodifiable Collection<? extends Element> entries)
extends Record
implements Element

An element that contains multiple sub elements (of any type). Note that array entry elements always have no key given (see Element.NO_KEY).

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
private final @NonNull @Unmodifiable Collection<? extends Element>	entries	The field for the entries record component.
private final @NonNull String	key	The field for the key record component.

Fields inherited from interface eu.cloudnetservice.driver.document.send.element.Element

NO_KEY

Constructor Summary

Constructors

Constructor	Description
ArrayElement(@NonNull String key, @NonNull @Unmodifiable Collection<? extends Element> entries)	Creates an instance of a ArrayElement record class.

Method Summary

Modifier and Type	Method	Description
void	accept(@NonNull ElementVisitor visitor)	Applies the given visitor to this element.
@NonNull @Unmodifiable Collection<? extends Element>	entries()	Returns the value of the entries 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.
@NonNull String	key()	Returns the value of the key record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Field Details

key

@NonNull
private final @NonNull String key

The field for the key record component.

entries

@NonNull
private final @NonNull @Unmodifiable Collection<? extends Element> entries

The field for the entries record component.

Constructor Details

ArrayElement

public ArrayElement(@NonNull
 @NonNull String key,
 @NonNull
 @NonNull @Unmodifiable Collection<? extends Element> entries)

Creates an instance of a ArrayElement record class.

Parameters:

key - the value for the key record component

entries - the value for the entries record component

Method Details

accept

public void accept(@NonNull
 @NonNull ElementVisitor visitor)

Applies the given visitor to this element. It is up to the implementation (and therefore the element type) to decide what steps should be executed on the given element visitor.

Specified by:

accept in interface Element

Parameters:

visitor - the visitor to apply to this element.

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

key

@NonNull
public @NonNull String key()

Returns the value of the key record component.

Specified by:

key in interface Element

Returns:

the value of the key record component

entries

@NonNull
public @NonNull @Unmodifiable Collection<? extends Element> entries()

Returns the value of the entries record component.

Returns:

the value of the entries record component