org.snmp4j.agent.mo.snmp.tc.DisplayStringTC Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of snmp4j-agent Show documentation

SNMP-Agent API for Java

There is a newer version: 3.8.1

/*_############################################################################
  _## 
  _##  SNMP4J-Agent 3 - DisplayStringTC.java  
  _## 
  _##  Copyright (C) 2005-2021  Frank Fock (SNMP4J.org)
  _##  
  _##  Licensed under the Apache License, Version 2.0 (the "License");
  _##  you may not use this file except in compliance with the License.
  _##  You may obtain a copy of the License at
  _##  
  _##      http://www.apache.org/licenses/LICENSE-2.0
  _##  
  _##  Unless required by applicable law or agreed to in writing, software
  _##  distributed under the License is distributed on an "AS IS" BASIS,
  _##  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  _##  See the License for the specific language governing permissions and
  _##  limitations under the License.
  _##  
  _##########################################################################*/

package org.snmp4j.agent.mo.snmp.tc;

import org.snmp4j.agent.*;
import org.snmp4j.agent.mo.*;
import org.snmp4j.smi.*;
import org.snmp4j.agent.mo.snmp.DisplayString;
import org.snmp4j.agent.mo.snmp.DisplayStringScalar;
import org.snmp4j.agent.mo.snmp.SNMPv2TC;

/**
 * The {@code DisplayStringTC} implements a {@link org.snmp4j.smi.OctetString} {@link TextualConvention} that
 * implements the SNMPv2-MIB DisplayString textual convention.
 *
 * @author Frank Fock
 * @version 3.1
 */
public class DisplayStringTC implements TextualConvention {

    public DisplayStringTC() {
    }

    public MOColumn createColumn(int columnID, int syntax, MOAccess access,
                                              OctetString defaultValue, boolean mutableInService) {
        return new DisplayString<>(columnID, access, defaultValue, mutableInService);
    }

    public MOScalar createScalar(OID oid, MOAccess access, OctetString value) {
        return new DisplayStringScalar<>(oid, access, ((value == null) ? createInitialValue() : value));
    }

    public String getModuleName() {
        return SNMPv2TC.MODULE_NAME;
    }

    public String getName() {
        return SNMPv2TC.DISPLAYSTRING;
    }

    public OctetString createInitialValue() {
        return new OctetString();
    }
}