Package com.io7m.aradine.instrument.spi1.xml.internal

Record Class ARI1InstrumentDescription

java.lang.Object

java.lang.Record

com.io7m.aradine.instrument.spi1.xml.internal.ARI1InstrumentDescription

Record Components:

identifier - The identifier

version - The version

metadata - The metadata

parameters - The parameters

ports - The ports

All Implemented Interfaces:

ARI1InstrumentDescriptionType

public record ARI1InstrumentDescription(String identifier, ARI1Version version, Map<String,String> metadata, Map<ARI1ParameterId,ARI1ParameterDescriptionType> parameters, Map<ARI1PortId,ARI1PortDescriptionType> ports)
extends Record
implements ARI1InstrumentDescriptionType

An instrument description.

Constructor Summary

Constructors

Constructor	Description
ARI1InstrumentDescription(String identifier, ARI1Version version, Map<String,String> metadata, Map<ARI1ParameterId,ARI1ParameterDescriptionType> parameters, Map<ARI1PortId,ARI1PortDescriptionType> ports)	Creates an instance of a ARI1InstrumentDescription record class.

Method Summary

Modifier and Type	Method	Description
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.
String	identifier()	Returns the value of the identifier record component.
Map<String,String>	metadata()	Returns the value of the metadata record component.
Map<ARI1ParameterId,ARI1ParameterDescriptionType>	parameters()	Returns the value of the parameters record component.
Map<ARI1PortId,ARI1PortDescriptionType>	ports()	Returns the value of the ports record component.
final String	toString()	Returns a string representation of this record class.
ARI1Version	version()	Returns the value of the version record component.

Methods inherited from class java.lang.Object

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

Constructor Details

ARI1InstrumentDescription

public ARI1InstrumentDescription(String identifier,
 ARI1Version version,
 Map<String,String> metadata,
 Map<ARI1ParameterId,ARI1ParameterDescriptionType> parameters,
 Map<ARI1PortId,ARI1PortDescriptionType> ports)

Creates an instance of a ARI1InstrumentDescription record class.

Parameters:

identifier - the value for the identifier record component

version - the value for the version record component

metadata - the value for the metadata record component

parameters - the value for the parameters record component

ports - the value for the ports 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. 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.

identifier

public String identifier()

Returns the value of the identifier record component.

Specified by:

identifier in interface ARI1InstrumentDescriptionType

Returns:

the value of the identifier record component

version

public ARI1Version version()

Returns the value of the version record component.

Specified by:

version in interface ARI1InstrumentDescriptionType

Returns:

the value of the version record component

metadata

public Map<String,String> metadata()

Returns the value of the metadata record component.

Specified by:

metadata in interface ARI1InstrumentDescriptionType

Returns:

the value of the metadata record component

parameters

public Map<ARI1ParameterId,ARI1ParameterDescriptionType> parameters()

Returns the value of the parameters record component.

Specified by:

parameters in interface ARI1InstrumentDescriptionType

Returns:

the value of the parameters record component

ports

public Map<ARI1PortId,ARI1PortDescriptionType> ports()

Returns the value of the ports record component.

Specified by:

ports in interface ARI1InstrumentDescriptionType

Returns:

the value of the ports record component