Package chemaxon.calculations.elemental

Record Class FormulaAtom

java.lang.Object

java.lang.Record

chemaxon.calculations.elemental.FormulaAtom

Record Components:

symbol - the atom symbol

massNumber - the optional value of the mass number of the atom, or empty if not specified

charge - the charge of the atom

@PublicApi
public record FormulaAtom(String symbol, Optional<Integer> massNumber, int charge)
extends Record

Represents an atom in an ElementalAnalysis.

Field Summary

Fields

Modifier and Type	Field	Description
static final FormulaAtom	HYDROGEN

Constructor Summary

Constructors

Constructor	Description
FormulaAtom(String symbol, int charge)	Creates a new instance with the given symbol and charge.
FormulaAtom(String symbol, int massNumber, int charge)	Creates a new instance with the given symbol, mass number and charge.
FormulaAtom(String symbol, Optional<Integer> massNumber, int charge)	Creates an instance of a FormulaAtom record class.

Method Summary

Modifier and Type	Method	Description
int	charge()	Returns the value of the charge 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.
Optional<Integer>	massNumber()	Returns the value of the massNumber record component.
String	symbol()	Returns the value of the symbol record component.
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

HYDROGEN

public static final FormulaAtom HYDROGEN

Constructor Details

FormulaAtom

public FormulaAtom(String symbol,
 int charge)

Creates a new instance with the given symbol and charge.

Parameters:

symbol - the atom symbol

charge - the charge of the atom

FormulaAtom

public FormulaAtom(String symbol,
 int massNumber,
 int charge)

Creates a new instance with the given symbol, mass number and charge.

Parameters:

symbol - the atom symbol

massNumber - the mass number of the atom

charge - the charge of the atom

FormulaAtom

public FormulaAtom(String symbol,
 Optional<Integer> massNumber,
 int charge)

Creates an instance of a FormulaAtom record class.

Parameters:

symbol - the value for the symbol record component

massNumber - the value for the massNumber record component

charge - the value for the charge record component

Method Details

toString

public 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.

symbol

public String symbol()

Returns the value of the symbol record component.

Returns:

the value of the symbol record component

massNumber

public Optional<Integer> massNumber()

Returns the value of the massNumber record component.

Returns:

the value of the massNumber record component

charge

public int charge()

Returns the value of the charge record component.

Returns:

the value of the charge record component