Package dev.getelements.elements.sdk.query

Record Class ElementQuery

java.lang.Object

java.lang.Record

dev.getelements.elements.sdk.query.ElementQuery

Record Components:

registry -

name -

index -

All Implemented Interfaces:

Query<Element>, Supplier<Element>

public record ElementQuery(ElementRegistry registry, String name, int index)
extends Record
implements Query<Element>

The beginning queyr for a Element instance based on a ElementRegistry.

Constructor Summary

Constructors

Constructor	Description
ElementQuery(ElementRegistry registry, String name, int index)	Creates an instance of a ElementQuery record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Optional<Element>	find()	Gets the Element for this ElementQuery.
<ServiceT> Optional<ElementServiceQuery<ServiceT>>	findService(ElementServiceKey<ServiceT> serviceKey)	Finds a ElementServiceQuery from the selected Element.
Optional<ElementServiceQuery<?>>	findService(String serviceKeyString)	Finds a ElementServiceQuery from the selected Element.
final int	hashCode()	Returns a hash code value for this object.
int	index()	Returns the value of the index record component.
String	name()	Returns the value of the name record component.
ElementRegistry	registry()	Returns the value of the registry record component.
<ServiceT> ElementServiceQuery<ServiceT>	service(ElementServiceKey<ServiceT> serviceKey)	Gets the ElementServiceQuery for the specific ElementServiceKey.
ElementServiceQuery<?>	service(String serviceKeyString)	Gets a ElementServiceQuery from the selected Element.
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

Methods inherited from interface dev.getelements.elements.sdk.query.Query

get

Constructor Details

ElementQuery

public ElementQuery(ElementRegistry registry,
 String name,
 int index)

Creates an instance of a ElementQuery record class.

Parameters:

registry - the value for the registry record component

name - the value for the name record component

index - the value for the index record component

Method Details

find

public Optional<Element> find()
                       throws QueryException

Gets the Element for this ElementQuery.

Specified by:

find in interface Query<Element>

Returns:

the Element

Throws:

QueryException

findService

public Optional<ElementServiceQuery<?>> findService(String serviceKeyString)

Finds a ElementServiceQuery from the selected Element.

Parameters:

serviceKeyString - the service key string

Returns:

the ElementServiceQuery

findService

public <ServiceT>
Optional<ElementServiceQuery<ServiceT>> findService(ElementServiceKey<ServiceT> serviceKey)

Finds a ElementServiceQuery from the selected Element.

Parameters:

serviceKey - the service key string

Returns:

the ElementServiceQuery

service

public ElementServiceQuery<?> service(String serviceKeyString)

Gets a ElementServiceQuery from the selected Element.

Parameters:

serviceKeyString - the service key string

Returns:

the ElementServiceQuery

service

public <ServiceT> ElementServiceQuery<ServiceT> service(ElementServiceKey<ServiceT> serviceKey)

Gets the ElementServiceQuery for the specific ElementServiceKey.

Type Parameters:

ServiceT -

Parameters:

serviceKey - the ElementServiceKey

Returns:

the ElementServiceQuery

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.

registry

public ElementRegistry registry()

Returns the value of the registry record component.

Returns:

the value of the registry record component

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

index

public int index()

Returns the value of the index record component.

Returns:

the value of the index record component