com.alee.utils.parsing

Class AbstractUnits.Unit

java.lang.Object

com.alee.utils.parsing.AbstractUnits.Unit

All Implemented Interfaces:

Comparable<AbstractUnits.Unit>

Enclosing class:

AbstractUnits

protected static final class AbstractUnits.Unit
extends Object
implements Comparable<AbstractUnits.Unit>

Class representing single measurement unit.

Constructor Summary

Constructors

Constructor and Description
Unit(long amount, long limit, String... names) Constructs new AbstractUnits.Unit.

Method Summary

Modifier and Type	Method and Description
int	compareTo(AbstractUnits.Unit other)
long	fromString(String value) Returns base long value calculated from the unit String value.
String	toString(long value) Returns user-friendly unit-based String of the base double value.
boolean	uses(String name) Returns whether or not this AbstractUnits.Unit uses specified name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Unit

public Unit(long amount,
            long limit,
            @NotNull
            String... names)

Constructs new AbstractUnits.Unit.

Parameters:

amount - base value to which this single unit is equal to

limit - value used to limit displayed value with this unit

names - displayable unit names

Method Detail

uses

public boolean uses(@NotNull
                    String name)

Returns whether or not this AbstractUnits.Unit uses specified name.

Parameters:

name - AbstractUnits.Unit name

Returns:

true if this AbstractUnits.Unit uses specified name, false otherwise

fromString

public long fromString(@NotNull
                       String value)

Returns base long value calculated from the unit String value.

Parameters:

value - unit String value

Returns:

base long value calculated from the unit String value

toString

public String toString(long value)

Returns user-friendly unit-based String of the base double value.

Parameters:

value - base double value

Returns:

user-friendly unit-based String of the base double value

compareTo

public int compareTo(@NotNull
                     AbstractUnits.Unit other)

Specified by:

compareTo in interface Comparable<AbstractUnits.Unit>