JASMI API

com.agentpp.smi
Interface ISyntax


public interface ISyntax

ISyntax represents a SYNTAX clause of OBJECT-TYPE, TEXTUAL-CONVENTION, and other SMIv1/v2 constructs.

Version:
1.0
Author:
Frank Fock

Field Summary
static int APPLICATION
          Denotes an APPLICATION syntax as specifed by ASN.1
static int CONVENTION
          Denotes a TEXTUAL CONVENTION that is defined based on SIMPLE or APPLICATION syntaxes.
static int SEQUENCE
          Denotes a SEQUENCE syntax used for defining tables.
static int SIMPLE
          Denotes a SIMPLE syntax, for example INTEGER, OCTET STRING, etc.
 
Method Summary
 IEnum[] getEnums()
          Gets the enumerated values specified for this syntax definition.
 IRange[] getRanges()
          Gets the range definitions for this syntax definition.
 java.lang.String getSyntax()
          Gets the syntax definition string.
 int getType()
          Gets the type of the syntax.
 boolean hasEnums()
          Checks whether the syntax definition specifies enumerated values.
 boolean hasRanges()
          Checks whether the syntax definition specifies any ranges.
 

Field Detail

APPLICATION

static final int APPLICATION
Denotes an APPLICATION syntax as specifed by ASN.1

See Also:
Constant Field Values

CONVENTION

static final int CONVENTION
Denotes a TEXTUAL CONVENTION that is defined based on SIMPLE or APPLICATION syntaxes.

See Also:
Constant Field Values

SIMPLE

static final int SIMPLE
Denotes a SIMPLE syntax, for example INTEGER, OCTET STRING, etc.

See Also:
Constant Field Values

SEQUENCE

static final int SEQUENCE
Denotes a SEQUENCE syntax used for defining tables.

See Also:
Constant Field Values
Method Detail

getSyntax

java.lang.String getSyntax()
Gets the syntax definition string.

Returns:
a String denoting a syntax, for example "Integer32".

hasRanges

boolean hasRanges()
Checks whether the syntax definition specifies any ranges.

Returns:
true if getRanges() returns not null.

getRanges

IRange[] getRanges()
Gets the range definitions for this syntax definition. Each range has a lower and an upper bound.

Returns:
an array of IRange instances or null if there are no range definitions for this syntax.

hasEnums

boolean hasEnums()
Checks whether the syntax definition specifies enumerated values.

Returns:
true if getEnums() returns not null.

getEnums

IEnum[] getEnums()
Gets the enumerated values specified for this syntax definition.

Returns:
an array of IEnum instances or null if there are no enumerated values defined for this syntax.

getType

int getType()
Gets the type of the syntax.

Returns:
an integer value. Possible values are APPLICATION, SEQUENCE, SIMPLE, and CONVENTION.

JASMI API

JASMI 3
Copyright 2001-2010 Frank Fock
All Rights Reserved