A C D E F G H I L M N O P S T U V

A

allUnitsRecognised(String) - Method in class uk.me.nxg.unity.UnitExpr
Indicates whether the parsed expression is composed only of recognised units, in the sense of OneUnit.isRecognisedUnit(java.lang.String).
allUnitsRecommended(String) - Method in class uk.me.nxg.unity.UnitExpr
Indicates whether the parsed expression is composed only of recommended units, in the sense of OneUnit.isRecommendedUnit(java.lang.String).
allUsageConstraintsSatisfied(String) - Method in class uk.me.nxg.unity.UnitExpr
Indicates whether the expression is being used in a way which satisfies any usage constraints, in the sense of OneUnit.satisfiesUsageConstraints(java.lang.String).

C

CDS - Static variable in class uk.me.nxg.unity.UnitParser
Indicates the parser for CDS-format strings

D

description() - Method in class uk.me.nxg.unity.UnitDefinition
Further remarks about this unit, or other comments
Dimensions - Class in uk.me.nxg.unity
A dimensions specification is a record of the measurement dimensions of a quantity.
dimensions() - Method in class uk.me.nxg.unity.UnitDefinition
The dimensions of this unit

E

equals(Object) - Method in class uk.me.nxg.unity.OneUnit
Two units are equal if they have the same power, units and exponent.
exponents() - Method in class uk.me.nxg.unity.Dimensions
Return the numerical dimensions of the quantities in the expression.

F

FITS - Static variable in class uk.me.nxg.unity.UnitParser
Indicates the parser for FITS-format strings

G

getAbbreviation() - Method in class uk.me.nxg.unity.UnitRepresentation
Returns a symbolic abbreviation for this unit in this syntax.
getBaseUnitDefinition() - Method in class uk.me.nxg.unity.OneUnit
Returns the known base unit.
getBaseUnitName() - Method in class uk.me.nxg.unity.OneUnit
Returns the name of this unit.
getDimensions() - Method in class uk.me.nxg.unity.OneUnit
Return the dimensions of the unit, if it is a recognised one.
getDimensions() - Method in class uk.me.nxg.unity.UnitExpr
Obtains the dimensions of the complete expression.
getExponent() - Method in class uk.me.nxg.unity.OneUnit
Obtains the power the unit is raised to.
getFactor() - Method in class uk.me.nxg.unity.UnitExpr
Obtain the factor multiplying this expression
getInstance() - Static method in class uk.me.nxg.unity.UnitDefinitionMap
Obtain an instance of the unit-definition map.
getLexeme() - Method in class uk.me.nxg.unity.UnitParser
Return successive lexemes from the input.
getLogFactor() - Method in class uk.me.nxg.unity.UnitExpr
Obtain the base-10 log of the factor multiplying this expression
getParsed() - Method in class uk.me.nxg.unity.UnitParser
Retrieve the parsed result
getParserTypes() - Static method in class uk.me.nxg.unity.UnitParser
Indicate the set of available parsers.
getPower() - Method in class uk.me.nxg.unity.OneUnit
Returns the power to which this unit is raised.
getPrefix() - Method in class uk.me.nxg.unity.OneUnit
Returns the prefix of the unit, as a base-ten log.
getRepresentation(String) - Method in class uk.me.nxg.unity.UnitDefinition
Return the syntax-specific information about this unit.
getUnit(UnitDefinition) - Method in class uk.me.nxg.unity.UnitExpr
Extracts the unit information from the expression, keyed by an abstract unit instance.
getUnit(String) - Method in class uk.me.nxg.unity.UnitExpr
Extracts the unit information from the expression, keyed by a symbolic name for the unit, as defined by the syntax which was used to parse the expression.
getUri() - Method in class uk.me.nxg.unity.Dimensions
Return a URI naming one of the dimensions in the QUDT dimensions ontology.
getUri() - Method in class uk.me.nxg.unity.UnitDefinition
The Kind of this unit, named by a URI

H

hashCode() - Method in class uk.me.nxg.unity.OneUnit
 
hasNext() - Method in class uk.me.nxg.unity.UnitRepresentation
If there is more than one representation for this unit in this syntax, then this will return the next one.

I

isDeprecated() - Method in class uk.me.nxg.unity.UnitRepresentation
Indicates whether this syntax deprecates (but still permits) the use of this unit.
isFullyConformant(String) - Method in class uk.me.nxg.unity.UnitExpr
Indicates whether the expression is fully conformant with the appropriate recommendations.
isKnownParser(String) - Static method in class uk.me.nxg.unity.UnitParser
Indicates whether the argument is the name of a known parser.
isRecognisedUnit(String) - Method in class uk.me.nxg.unity.OneUnit
Indicates whether the base unit is one of those recognised within the specification of the given syntax.
isRecommendedUnit(String) - Method in class uk.me.nxg.unity.OneUnit
Indicates whether the base unit is one of those recommended within the specification of the given syntax.
iterator() - Method in class uk.me.nxg.unity.UnitExpr
Return a representation of the parsed expression as an iterator.

L

LATEX - Static variable in class uk.me.nxg.unity.UnitParser
Indicates the formatter (not parser) for LaTeX/siunitx output
latexForm() - Method in class uk.me.nxg.unity.UnitDefinition
A LaTeX version of the unit symbol, if there is one defined
lookupUnitDefinition(String, String) - Method in class uk.me.nxg.unity.UnitDefinitionMap
Obtain unit-definition information for a symbol, as interpreted in a particular syntax.

M

main(String[]) - Static method in class uk.me.nxg.unity.UnitParser
The library main program, for exploring the library's functionality.
mayHaveSIPrefixes() - Method in class uk.me.nxg.unity.UnitRepresentation
Indicates whether this unit may be used with SI prefixes.
multiply(Dimensions) - Method in class uk.me.nxg.unity.Dimensions
Respond with a Dimensions object which is the result of multiplying the dimensions of this object by the dimensions of another.
multiply(Iterable<Dimensions>) - Static method in class uk.me.nxg.unity.Dimensions
Multiplies several dimensions together, and returns a (new) object representing the dimensions of the result.

N

name() - Method in class uk.me.nxg.unity.UnitDefinition
The name of this unit, for example 'metre'
next() - Method in class uk.me.nxg.unity.UnitRepresentation
Returns true if hasNext() would succeed.

O

OGIP - Static variable in class uk.me.nxg.unity.UnitParser
Indicates the parser for OGIP-format strings
OneUnit - Class in uk.me.nxg.unity
A single unit.

P

parse(String) - Static method in class uk.me.nxg.unity.Dimensions
Parse a dimension string to produce a new dimension object.

S

satisfiesUsageConstraints(String) - Method in class uk.me.nxg.unity.OneUnit
Indicates whether the unit is being used in a way which satisfies any usage constraints.

T

toDebugString() - Method in class uk.me.nxg.unity.OneUnit
Write out the unit in a testable format.
toDebugString() - Method in class uk.me.nxg.unity.UnitExpr
Format the unit expression as a string, in some sort of canonical/unambiguous form.
token - Variable in class uk.me.nxg.unity.UnitParser.Lexeme
 
toString() - Method in class uk.me.nxg.unity.OneUnit
Format this unit in some sort of canonical form.
toString() - Method in class uk.me.nxg.unity.UnitDefinition
Produces a representation of this unit as a string.
toString() - Method in class uk.me.nxg.unity.UnitExpr
Produces a string representation of the unit expression, in a form suitable for display
toString(String) - Method in class uk.me.nxg.unity.UnitExpr
Produces a string representation of the unit expression, in a format appropriate to the given syntax.
toString(String, Locale) - Method in class uk.me.nxg.unity.UnitExpr
Produces a string representation of the unit expression, in a format appropriate to the given syntax, and with output respecting the conventions of the given locale.
toString() - Method in class uk.me.nxg.unity.UnitRepresentation
 
type() - Method in class uk.me.nxg.unity.UnitDefinition
A description of the type of this unit, for example 'length'

U

uk.me.nxg.unity - package uk.me.nxg.unity
The Unity package provides a parser for unit strings.
UnitDefinition - Class in uk.me.nxg.unity
Describes a unit.
UnitDefinitionMap - Class in uk.me.nxg.unity
Provides a mapping from unit abbreviations to unit definitions.
UnitExpr - Class in uk.me.nxg.unity
A parsed unit expression.
UnitParser - Class in uk.me.nxg.unity
A parser for unit strings.
UnitParser(String, String) - Constructor for class uk.me.nxg.unity.UnitParser
Create a new unit parser.
UnitParser.Lexeme - Class in uk.me.nxg.unity
A single lexeme.
UnitParserException - Exception in uk.me.nxg.unity
Thrown when an expression cannot be parsed.
UnitRepresentation - Class in uk.me.nxg.unity
A description of the way that a unit is represented in a particular syntax.
unitString(String) - Method in class uk.me.nxg.unity.OneUnit
Obtains the string representation of the unit, including prefix, in the given syntax.
unitString() - Method in class uk.me.nxg.unity.OneUnit
Obtains the string form of the unit, including prefix, with a default syntax.

V

value - Variable in class uk.me.nxg.unity.UnitParser.Lexeme
 
Version - Class in uk.me.nxg.unity
Manage version information
versionInteger() - Static method in class uk.me.nxg.unity.Version
Indicate the package version, as an integer.
versionString() - Static method in class uk.me.nxg.unity.Version
Indicate the package version, as a printable string giving the package name and version

A C D E F G H I L M N O P S T U V