-
- All Known Implementing Classes:
SimpleVariableTextFormat
public interface VariableTextFormat
TheVariableTextFormat
provides a textual representation of SNMPVariable
s, in dependence of their associated (instance) OID.- Since:
- 1.10
- Version:
- 1.10
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
format(OID instanceOID, Variable variable, boolean withOID)
Returns a textual representation of the supplied variable against the optionally supplied instance OID.Variable
parse(int smiSyntax, java.lang.String text)
Parses a textual representation of a variable against a SMI type.Variable
parse(OID classOrInstanceOID, java.lang.String text)
Parses a textual representation of a variable against its associated OBJECT-TYPE OID.VariableBinding
parseVariableBinding(java.lang.String text)
Parses a textual representation of a variable binding.
-
-
-
Method Detail
-
format
java.lang.String format(OID instanceOID, Variable variable, boolean withOID)
Returns a textual representation of the supplied variable against the optionally supplied instance OID.- Parameters:
instanceOID
- the instance OIDvariable
is associated with. Ifnull
the formatting cannot take any MIB specification of the variable into account and has to format it based on its type only.variable
- the variable to format.withOID
- iftrue
theinstanceOID
should be included in the textual representation to form aVariableBinding
representation.- Returns:
- the textual representation.
-
parseVariableBinding
VariableBinding parseVariableBinding(java.lang.String text) throws java.text.ParseException
Parses a textual representation of a variable binding.- Parameters:
text
- a textual representation of the variable binding.- Returns:
- the new
VariableBinding
instance. - Throws:
java.text.ParseException
- if the variable binding cannot be parsed successfully.
-
parse
Variable parse(OID classOrInstanceOID, java.lang.String text) throws java.text.ParseException
Parses a textual representation of a variable against its associated OBJECT-TYPE OID.- Parameters:
classOrInstanceOID
- the instance OIDvariable
is associated with. Must not benull
.text
- a textual representation of the variable.- Returns:
- the new
Variable
instance. - Throws:
java.text.ParseException
- if the variable cannot be parsed successfully.
-
parse
Variable parse(int smiSyntax, java.lang.String text) throws java.text.ParseException
Parses a textual representation of a variable against a SMI type.- Parameters:
smiSyntax
- the SMI syntax identifier identifying the targetVariable
.text
- a textual representation of the variable.- Returns:
- the new
Variable
instance. - Throws:
java.text.ParseException
- if the variable cannot be parsed successfully.
-
-