Package loci.formats

Class FilePatternBlock

java.lang.Object

loci.formats.FilePatternBlock

public class FilePatternBlock
extends Object

FilePatternBlock represents a single block in a FilePattern.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BLOCK_END	Identifies the end of a block.
static final String	BLOCK_START	Identifies the start of a block.

Constructor Summary

Constructors

Constructor	Description
FilePatternBlock(String block)	Builds a FilePatternBlock from a block string.

Method Summary

Modifier and Type	Method	Description
String	getBlock()	Gets the block string.
String[]	getElements()	Gets all block elements.
BigInteger	getFirst()	Gets the first element in a range block.
BigInteger	getLast()	Gets the last element in a range block.
BigInteger	getStep()	Gets the difference between consecutive elements in a range block.
boolean	isFixed()	Whether or not this is a fixed-width block.
boolean	isNumeric()	Whether or not this is a numeric block.

Methods inherited from class java.lang.Object

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

Field Details

BLOCK_START

public static final String BLOCK_START

Identifies the start of a block.

See Also:

• Constant Field Values

BLOCK_END

public static final String BLOCK_END

Identifies the end of a block.

See Also:

• Constant Field Values

Constructor Details

FilePatternBlock

public FilePatternBlock(String block)

Builds a FilePatternBlock from a block string. See FilePattern for block string syntax.

Parameters:

block - the block string.

Method Details

getElements

public String[] getElements()

Gets all block elements.

Returns:

an array containing all block elements.

getBlock

public String getBlock()

Gets the block string.

Returns:

the block string.

isFixed

public boolean isFixed()

Whether or not this is a fixed-width block. All elements in a fixed-width block have the same length (numbers are zero-padded as needed).

Returns:

true if this is a fixed-width block, false otherwise.

isNumeric

public boolean isNumeric()

Whether or not this is a numeric block. All elements in a numeric block consist of digit characters. For instance, <10-15:2> expands to 10, 13, 15, all of which consist only of digits.

Returns:

true if this is a numeric block, false otherwise.

getFirst

public BigInteger getFirst()

Gets the first element in a range block.

Returns:

the first block element

getLast

public BigInteger getLast()

Gets the last element in a range block.

Returns:

the last block element

getStep

public BigInteger getStep()

Gets the difference between consecutive elements in a range block.

Returns:

the step element as defined above.