net.percederberg.mibble.type
Class BitSetType

java.lang.Object
  extended bynet.percederberg.mibble.type.BitSetType
All Implemented Interfaces:
MibContext, MibType

public class BitSetType
extends java.lang.Object
implements MibType, MibContext

A bit set MIB type.

Since:
2.0

Constructor Summary
BitSetType()
          Creates a new bit set MIB type.
BitSetType(java.util.ArrayList values)
          Creates a new integer MIB type.
BitSetType(Constraint constraint)
          Creates a new bit set MIB type.
 
Method Summary
 MibSymbol getSymbol(java.lang.String name)
          Returns a named MIB symbol.
 boolean hasConstraint()
          Checks if this type has any constraint.
 boolean hasSymbols()
          Checks if this type has any defined value symbols.
 MibType initialize(MibLoaderLog log)
          Initializes the MIB type.
 boolean isCompatible(BitSetValue value)
          Checks if the specified bit set value is compatible with this type.
 boolean isCompatible(MibValue value)
          Checks if the specified value is compatible with this type.
 java.lang.String toString()
          Returns a string representation of this type.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BitSetType

public BitSetType()
Creates a new bit set MIB type.


BitSetType

public BitSetType(Constraint constraint)
Creates a new bit set MIB type.

Parameters:
constraint - the additional type constraint

BitSetType

public BitSetType(java.util.ArrayList values)
Creates a new integer MIB type.

Parameters:
values - the additional defined symbols
Method Detail

initialize

public MibType initialize(MibLoaderLog log)
                   throws MibException
Initializes the MIB type. This will remove all levels of indirection present, such as references to other types, and returns the basic type. No type information is lost by this operation. This method may modify this object as a side-effect, and will be called by the MIB loader.

Specified by:
initialize in interface MibType
Parameters:
log - the MIB loader log
Returns:
the basic MIB type
Throws:
MibException - if an error was encountered during the initialization

hasConstraint

public boolean hasConstraint()
Checks if this type has any constraint.

Returns:
true if this type has any constraint, or false otherwise

hasSymbols

public boolean hasSymbols()
Checks if this type has any defined value symbols.

Returns:
true if this type has any defined value symbols, or false otherwise

isCompatible

public boolean isCompatible(MibValue value)
Checks if the specified value is compatible with this type. A value is compatible if it is a bit set value with all components compatible with the constraints.

Specified by:
isCompatible in interface MibType
Parameters:
value - the value to check
Returns:
true if the value is compatible, or false otherwise

isCompatible

public boolean isCompatible(BitSetValue value)
Checks if the specified bit set value is compatible with this type. A value is compatible if all the bits are compatible with the constraints.

Parameters:
value - the value to check
Returns:
true if the value is compatible, or false otherwise

getSymbol

public MibSymbol getSymbol(java.lang.String name)
Returns a named MIB symbol. This method returns predefined integer values, if some exist.

Specified by:
getSymbol in interface MibContext
Parameters:
name - the symbol name
Returns:
the MIB symbol, or null if not found

toString

public java.lang.String toString()
Returns a string representation of this type.

Returns:
a string representation of this type