de.hybris.platform.jalo.numberseries

Class NumberSeries

java.lang.Object

de.hybris.platform.jalo.numberseries.NumberSeries

All Implemented Interfaces:

Serializable

public class NumberSeries
extends Object
implements Serializable

Represents a serial number generated by NumberSeriesManager.getUniqueNumber(String, int) or SerialNumberGenerator.getUniqueNumber(String). Generally unique numbers should be obtained via NumberSeriesManager.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Logger	LOG
static int	TYPE_ALPHANUMERIC
static int	TYPE_NUMERIC

Constructor Summary

Constructors

Constructor and Description
NumberSeries(String key, long value, int type) Deprecated. since 5.0 - please use NumberSeries(String, long, int, String)
NumberSeries(String key, long value, int type, String template) Creates a new number series value with the given key, value and type.
NumberSeries(String key, String formattedValue, int type) Deprecated. since 5.0 - please use NumberSeries(String, String, int, String)
NumberSeries(String key, String formattedValue, int type, String template) Creates a new number series value with the given key, formatted value and type.

Method Summary

Modifier and Type	Method and Description
protected String	applyPatternIfExists(String formattedNumber)
long	getCurrentNumber() Returns the long representation this value.
String	getCurrentValue() Deprecated. use getFormatted(int) instead
String	getFormatted(int digits) Returns a formatted version of this value.
String	getKey() The sequence key.
String	getTemplate() The sequence template.
int	getType() The sequence type.
protected String	replaceSpecialCharacters(String template, String formattedNumber)
void	setCurrentValue(String value) Deprecated. has no function
void	setKey(String key) Deprecated. has no function
void	setTemplate(String template) Deprecated. has no function
void	setType(int type) Deprecated. has no function

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static Logger LOG

TYPE_ALPHANUMERIC

public static final int TYPE_ALPHANUMERIC

See Also:

Constant Field Values

TYPE_NUMERIC

public static final int TYPE_NUMERIC

See Also:

Constant Field Values

Constructor Detail

NumberSeries

@Deprecated
public NumberSeries(String key,
                                String formattedValue,
                                int type)

Deprecated. since 5.0 - please use NumberSeries(String, String, int, String)

Creates a new number series value with the given key, formatted value and type.

Parameters:

key - the number series key

formattedValue - a formatted value

type - the sequence type see NumberGenerator.NumberSeriesConstants.TYPES

Throws:

NumberFormatException - if the formatted value could not be parsed while calculating its long representation

NumberSeries

public NumberSeries(String key,
                    String formattedValue,
                    int type,
                    String template)

Creates a new number series value with the given key, formatted value and type.

Parameters:

key - the number series key

formattedValue - a formatted value

type - the sequence type see NumberGenerator.NumberSeriesConstants.TYPES

template - the template to be applied on generated number

Throws:

NumberFormatException - if the formatted value could not be parsed while calculating its long representation

NumberSeries

@Deprecated
public NumberSeries(String key,
                                long value,
                                int type)

Deprecated. since 5.0 - please use NumberSeries(String, long, int, String)

Creates a new number series value with the given key, value and type.

Parameters:

key - the key of the number series value

value - the long value

type - the series type

NumberSeries

public NumberSeries(String key,
                    long value,
                    int type,
                    String template)

Creates a new number series value with the given key, value and type.

Parameters:

key - the key of the number series value

value - the long value

type - the series type

template - the template to be used with generated number

Method Detail

getCurrentNumber

public long getCurrentNumber()

Returns the long representation this value.

getCurrentValue

@Deprecated
public String getCurrentValue()

Deprecated. use getFormatted(int) instead

The formatted value.

getFormatted

public String getFormatted(int digits)

Returns a formatted version of this value. The result text contains at least the number of specified characters. If the underlying number does not fill it completely zeros are prepended.

Parameters:

digits - the number of digits to fill; if < 0 no leading zeros are prepended

applyPatternIfExists

protected String applyPatternIfExists(String formattedNumber)

replaceSpecialCharacters

protected String replaceSpecialCharacters(String template,
                                          String formattedNumber)

getTemplate

public String getTemplate()

The sequence template.

getKey

public String getKey()

The sequence key.

getType

public int getType()

The sequence type. Should be one of TYPE_ALPHANUMERIC or TYPE_NUMERIC - otherwise getFormatted(int) will always return numeric values.

setTemplate

@Deprecated
public void setTemplate(String template)

Deprecated. has no function

setCurrentValue

@Deprecated
public void setCurrentValue(String value)

Deprecated. has no function

setKey

@Deprecated
public void setKey(String key)

Deprecated. has no function

setType

@Deprecated
public void setType(int type)

Deprecated. has no function