Package org.tn5250j.tools.encoder

Class EncodeComponent.Encoding

  • Enclosing class:
    EncodeComponent
    public static class EncodeComponent.Encoding
extends java.lang.Object
    Class used to enumerate valid encodings

    • Constructor Summary

      Constructors 
      Constructor Description
      Encoding​(java.lang.String short_name, java.lang.String long_name, java.lang.String encoder_class, java.lang.String failure_message)
      Constructs and new image encoder.

    • Method Summary

      Modifier and Type Method Description
      Encoder getEncoder()
      Return an encoder for this encoding type.
      java.lang.String getFailureMessage()
      Message to return about possible reasons for encoder load failure (i.e. getEncoder() returns null)
      java.lang.String getLongName()
      Return the long name of the supported encoding type
      java.lang.String getShortName()
      Return the short brief name of the supported encoding type
      java.lang.String toString()
      Returns a string representation bassed on the long and short name of the Encoder.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Encoding

        public Encoding​(java.lang.String short_name,
                java.lang.String long_name,
                java.lang.String encoder_class,
                java.lang.String failure_message)
        Constructs and new image encoder.
        Parameters:
        short_name - name
        long_name - name
        encoder_class - classname
        failure_message - message

    • Method Detail

      • getShortName

        public java.lang.String getShortName()
        Return the short brief name of the supported encoding type
        Returns:
        string

      • getLongName

        public java.lang.String getLongName()
        Return the long name of the supported encoding type
        Returns:
        string

      • toString

        public java.lang.String toString()
        Returns a string representation bassed on the long and short name of the Encoder.
        Overrides:
        toString in class java.lang.Object
        Returns:
        string

      • getFailureMessage

        public java.lang.String getFailureMessage()
        Message to return about possible reasons for encoder load failure (i.e. getEncoder() returns null)
        Returns:
        string

      • getEncoder

        public Encoder getEncoder()
        Return an encoder for this encoding type.
        Returns:
        returns null if it cannot locate or load the encoder