Class SimpleOIDTextFormat

java.lang.Object
org.snmp4j.util.SimpleOIDTextFormat
All Implemented Interfaces:
OIDTextFormat
Direct Known Subclasses:
DictionaryOIDTextFormat
public class SimpleOIDTextFormat extends Object implements OIDTextFormat
The SimpleOIDTextFormat implements a simple textual representation for object IDs as dotted string.
Since:
1.10
Version:
2.2
Author:
Frank Fock

  • Constructor Summary

    Constructors
    Constructor
    Description
    SimpleOIDTextFormat()
    Creates a simple OID text format.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    format(int[] value)
    Returns a textual representation of a raw object ID as a dotted string ("1.3.6.1.4").
    String
    formatForRoundTrip(int[] value)
    Returns a textual representation of a raw object ID as a dotted string ("1.3.6.1.4").
    static String
    formatOID(int[] value)
    Returns a textual representation of a raw object ID as a dotted string ("1.3.6.1.4").
    int[]
    parse(String text)
    Parses a textual representation of an object ID as dotted string (e.g. "1.3.6.1.2.1.1") and returns its raw value.
    static int[]
    parseOID(String text)
    Parses a textual representation of an object ID as dotted string (e.g. "1.3.6.1.2.1.1") and returns its raw value.

    Methods inherited from class Object

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

  • Constructor Details

    • SimpleOIDTextFormat

      public SimpleOIDTextFormat()
      Creates a simple OID text format.

  • Method Details

    • formatOID

      public static String formatOID(int[] value)
      Returns a textual representation of a raw object ID as a dotted string ("1.3.6.1.4").
      Parameters:
      value - the OID value to format.
      Returns:
      the textual representation.

    • format

      public String format(int[] value)
      Returns a textual representation of a raw object ID as a dotted string ("1.3.6.1.4").
      Specified by:
      format in interface OIDTextFormat
      Parameters:
      value - the OID value to format.
      Returns:
      the textual representation.

    • formatForRoundTrip

      public String formatForRoundTrip(int[] value)
      Returns a textual representation of a raw object ID as a dotted string ("1.3.6.1.4"). This method is the same as format(int[]).
      Specified by:
      formatForRoundTrip in interface OIDTextFormat
      Parameters:
      value - the OID value to format.
      Returns:
      the textual representation.

    • parseOID

      public static int[] parseOID(String text) throws ParseException
      Parses a textual representation of an object ID as dotted string (e.g. "1.3.6.1.2.1.1") and returns its raw value.
      Parameters:
      text - a textual representation of an OID.
      Returns:
      the raw OID value.
      Throws:
      ParseException - if the OID cannot be parsed successfully.

    • parse

      public int[] parse(String text) throws ParseException
      Parses a textual representation of an object ID as dotted string (e.g. "1.3.6.1.2.1.1") and returns its raw value.
      Specified by:
      parse in interface OIDTextFormat
      Parameters:
      text - a textual representation of an OID.
      Returns:
      the raw OID value.
      Throws:
      ParseException - if the OID cannot be parsed successfully.