A C F G I K L M N O P S T U V

A

addSyntax(String, String, String) - Method in class uk.me.nxg.unity.UnitDefinition
Add a new syntax to this unit definition.
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).
asList() - Method in class uk.me.nxg.unity.UnitExpr
Return a representation of the parsed expression as a list of OneUnits.

C

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

F

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

G

getAbbrevs() - Method in class uk.me.nxg.unity.UnitDefinition.Syntax
Indicates how this unit is described in this syntax.
getBaseUnit() - Method in class uk.me.nxg.unity.OneUnit
Returns the base unit for this string, in a default syntax
getBaseUnit(String) - Method in class uk.me.nxg.unity.OneUnit
Returns the base unit for this string, in the given syntax
getBaseUnitDefinition() - Method in class uk.me.nxg.unity.OneUnit
 
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
getOneAbbrev() - Method in class uk.me.nxg.unity.UnitDefinition.Syntax
Get a single abbrev for this unit.
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.
getSyntax(String) - Method in class uk.me.nxg.unity.UnitDefinition
Return the syntax-specific information about this unit.
getSyntaxes() - Method in class uk.me.nxg.unity.UnitDefinition
Produces a set of the syntax names for this unit
getUnit(String) - Method in class uk.me.nxg.unity.UnitExpr
Returns the unit with the given base-unit.

I

isDeprecated() - Method in class uk.me.nxg.unity.UnitDefinition.Syntax
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.

K

keySet() - Method in class uk.me.nxg.unity.UnitDefinitionMap
Obtains all of the unit abbreviations known to this map.

L

LATEX - Static variable in class uk.me.nxg.unity.UnitParser
Indicates the formatter (not parser) for LaTeX/siunitx output
latexAbbrev() - Method in class uk.me.nxg.unity.UnitDefinition.Syntax
Get a version of an abbrev, suitable for outputting as part of the LaTeX representation of this unit.
latexForm() - Method in class uk.me.nxg.unity.UnitDefinition
A LaTeX version of the unit abbrev, or null if a syntax-specific abbrev should be used
lookup(String) - Method in class uk.me.nxg.unity.UnitDefinitionMap
Looks up the unit which corresponds to a unit abbreviation

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.UnitDefinition.Syntax
Indicates whether this unit may be used with SI prefixes.

N

name() - Method in class uk.me.nxg.unity.UnitDefinition
The name of this unit, for example 'metre'
notes() - Method in class uk.me.nxg.unity.UnitDefinition
Further remarks about this unit, or other comments

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

persist(Map<String, UnitDefinition>, File) - Static method in class uk.me.nxg.unity.UnitDefinitionMap
Persist a mapping of unit abbreviations to unit definitions.

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.Syntax
 
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.
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.
UnitDefinition(String, String, String, String) - Constructor for class uk.me.nxg.unity.UnitDefinition
 
UnitDefinition.Syntax - Class in uk.me.nxg.unity
Describes the per-syntax information about 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.
unitString(String) - Method in class uk.me.nxg.unity.OneUnit
Obtains the string form 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 F G I K L M N O P S T U V