jj2000.j2k

Class StringSpec

java.lang.Object

jj2000.j2k.ModuleSpec

jj2000.j2k.StringSpec

All Implemented Interfaces:

Cloneable

public class StringSpec
extends ModuleSpec

This class extends ModuleSpec class in order to hold tile-component specifications using Strings.

See Also:

ModuleSpec

Field Summary

Fields

Modifier and Type	Field and Description
private String	specified

Fields inherited from class jj2000.j2k.ModuleSpec

compDef, def, nComp, nTiles, SPEC_COMP_DEF, SPEC_DEF, SPEC_TILE_COMP, SPEC_TILE_DEF, SPEC_TYPE_COMP, SPEC_TYPE_TILE, SPEC_TYPE_TILE_COMP, specType, specValType, tileCompVal, tileDef

Constructor Summary

Constructors

Constructor and Description
StringSpec(int nt, int nc, byte type) Constructs an empty 'StringSpec' with specified number of tile and components.
StringSpec(int nt, int nc, byte type, String defaultValue, String[] list, J2KImageWriteParamJava wp, String values) Constructs a new 'StringSpec' for the specified number of components:tiles and the arguments of optName option.

Method Summary

Methods

Modifier and Type	Method and Description
String	getSpecified()

Methods inherited from class jj2000.j2k.ModuleSpec

clone, getCompDef, getCopy, getDefault, getSpec, getSpecValType, getTileCompVal, getTileDef, isCompSpecified, isTileCompSpecified, isTileSpecified, parseIdx, rotate90, setCompDef, setDefault, setTileCompVal, setTileDef

Methods inherited from class java.lang.Object

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

Field Detail

specified

private String specified

Constructor Detail

StringSpec

public StringSpec(int nt,
          int nc,
          byte type)

Constructs an empty 'StringSpec' with specified number of tile and components. This constructor is called by the decoder.

Parameters:

nt - Number of tiles

nc - Number of components

type - the type of the specification module i.e. tile specific, component specific or both.

StringSpec

public StringSpec(int nt,
          int nc,
          byte type,
          String defaultValue,
          String[] list,
          J2KImageWriteParamJava wp,
          String values)

Constructs a new 'StringSpec' for the specified number of components:tiles and the arguments of optName option. This constructor is called by the encoder. It also checks that the arguments belongs to the recognized arguments list.

Note: The arguments must not start with 't' or 'c' since it is reserved for respectively tile and components indexes specification.

Parameters:

nt - The number of tiles

nc - The number of components

type - the type of the specification module i.e. tile specific, component specific or both.

defaultValue - name of the option using boolean spec.

list - The list of all recognized argument in a String array

Method Detail

getSpecified

public String getSpecified()