org.apache.commons.id
Interface StringIdentifierGenerator

All Superinterfaces:

IdentifierGenerator

All Known Implementing Classes:

AbstractStringIdentifierGenerator, AlphanumericGenerator, CompositeIdentifierGenerator, ConstantIdentifierGenerator, NumericGenerator, PrefixedAlphanumericGenerator, PrefixedLeftPaddedNumericGenerator, PrefixedNumericGenerator, SessionIdGenerator, TimeBasedAlphanumericIdentifierGenerator

public interface StringIdentifierGenerator
extends IdentifierGenerator

StringIdentifierGenerator defines a simple interface for String based identifier generation.

Version:

$Id: StringIdentifierGenerator.java 480488 2006-11-29 08:57:26Z bayard $

Author:

Commons-Id team

Field Summary

static int

INFINITE_MAX_LENGTH Constant representing unlimited identifier length, returned by maxLength() when there is no upper bound to the length of an identifier in the sequence

Method Summary

long	maxLength() Returns the maximum length (number or characters) for an identifier from this sequence.
long	minLength() Returns the minimum length (number of characters) for an identifier from this sequence.
java.lang.String	nextStringIdentifier() Gets the next identifier in the sequence.

Methods inherited from interface org.apache.commons.id.IdentifierGenerator

nextIdentifier

Field Detail

INFINITE_MAX_LENGTH

static final int INFINITE_MAX_LENGTH

Constant representing unlimited identifier length, returned by maxLength() when there is no upper bound to the length of an identifier in the sequence

See Also:

Constant Field Values

Method Detail

nextStringIdentifier

java.lang.String nextStringIdentifier()

Gets the next identifier in the sequence.

Returns:

the next String identifier in sequence

maxLength

long maxLength()

Returns the maximum length (number or characters) for an identifier from this sequence.

Returns:

the maximum identifier length, or INFINITE_MAX_LENGTH if there is no upper bound

minLength

long minLength()

Returns the minimum length (number of characters) for an identifier from this sequence.

Returns:

the minimum identifier length