Class BaseEncodeType

  • Direct Known Subclasses:
    SymbologyEncodeType

    public class BaseEncodeType
    extends java.lang.Object

    Base class for SymbologyEncodeType.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected BaseEncodeType​(short typeIndex, java.lang.String typeName, int classification)
      Deprecated.
      protected BaseEncodeType​(short typeIndex, java.lang.String typeName, BarcodeClassifications classification)
      Initializes a new instance of BaseEncodeType class by type index and name
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object other)
      Returns a value indicating whether this instance is equal to a specified BaseEncodeType value.
      BarcodeClassifications getClassification()
      Gets a classification of this symbology.
      java.lang.String getString()
      Converts the instance of BaseEncodeType to its equivalent string representation.
      static java.lang.String getString​(BaseEncodeType instance)
      Converts the instance of BaseEncodeType to its equivalent string representation.
      short getTypeIndex()
      Gets an index of encode type
      java.lang.String getTypeName()
      Gets a name of encode type
      int hashCode()
      Returns the hash code for this instance.
      static BaseEncodeType parse​(java.lang.String stringEncodeType)
      Converts the string representation of the name of a BaseEncodeType to its instance.
      java.lang.String toString()
      Returns the name of the given BaseEncodeType as a string.
      static boolean tryParse​(java.lang.String parsingType, BaseEncodeType[] result)
      Converts the string representation of a BaseEncodeType to its instance.
      static boolean tryParse​(java.lang.String parsingType, SymbologyEncodeType[] result)
      Converts the string representation of a BaseEncodeType to its instance.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • BaseEncodeType

        protected BaseEncodeType​(short typeIndex,
                                 java.lang.String typeName,
                                 BarcodeClassifications classification)

        Initializes a new instance of BaseEncodeType class by type index and name

        Parameters:
        typeIndex - type index
        typeName - name of symbology
        classification - EncodeType classification.
      • BaseEncodeType

        @Deprecated
        protected BaseEncodeType​(short typeIndex,
                                 java.lang.String typeName,
                                 int classification)
        Deprecated.

        Initializes a new instance of BaseEncodeType class by type index and name

        Parameters:
        typeIndex - type index
        typeName - name of symbology
        classification - EncodeType classification.
    • Method Detail

      • getTypeIndex

        public short getTypeIndex()

        Gets an index of encode type

      • getTypeName

        public java.lang.String getTypeName()

        Gets a name of encode type

      • getClassification

        public BarcodeClassifications getClassification()

        Gets a classification of this symbology.

      • toString

        public java.lang.String toString()

        Returns the name of the given BaseEncodeType as a string.

        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representing the name of the encode type
      • getString

        public java.lang.String getString()

        Converts the instance of BaseEncodeType to its equivalent string representation. The string format is: "Index:0; Name:Codabar".

        Returns:
        A string representing the complete value of the encode type
      • getString

        public static java.lang.String getString​(BaseEncodeType instance)

        Converts the instance of BaseEncodeType to its equivalent string representation. The string format is: "Index:-1; Name:None".

        Parameters:
        instance - The BaseEncodeType instance to convert
        Returns:
        A string representing the complete value of the given encode type
      • tryParse

        public static boolean tryParse​(java.lang.String parsingType,
                                       BaseEncodeType[] result)

        Converts the string representation of a BaseEncodeType to its instance. A return value indicates whether the conversion succeeded or failed.

        Parameters:
        parsingType - A string in the format as "Index:-1; Name:None" to convert.
        result - An actual SingleEncodeType returns, when conversion has completed successfully;

        otherwise it returns null.

        Returns:
        <b>true</b> if s was converted successfully; otherwise, <b>false</b>.
      • tryParse

        public static boolean tryParse​(java.lang.String parsingType,
                                       SymbologyEncodeType[] result)

        Converts the string representation of a BaseEncodeType to its instance. A return value indicates whether the conversion succeeded or failed.

        Parameters:
        parsingType - A string in the format as "Index:-1; Name:None" to convert.
        result - An actual SingleEncodeType returns, when conversion has completed successfully;

        otherwise it returns null.

        Returns:
        <b>true</b> if s was converted successfully; otherwise, <b>false</b>.
      • equals

        public boolean equals​(java.lang.Object other)

        Returns a value indicating whether this instance is equal to a specified BaseEncodeType value.

        Overrides:
        equals in class java.lang.Object
        Parameters:
        other - An BaseEncodeType value to compare to this instance.
        Returns:
        <b>true</b> if obj has the same value as this instance; otherwise, <b>false</b>.
      • hashCode

        public int hashCode()

        Returns the hash code for this instance.

        Overrides:
        hashCode in class java.lang.Object
        Returns:
        A 32-bit signed integer hash code.
      • parse

        public static BaseEncodeType parse​(java.lang.String stringEncodeType)

        Converts the string representation of the name of a BaseEncodeType to its instance.

        Parameters:
        stringEncodeType - A string containing the name of a BaseEncodeType to convert.
        Returns:
        the instance of , if conversion was successful; otherwise, it returns <b></b>.