org.tn5250j.tools.encoder

Class EncodeComponent.Encoding

java.lang.Object

org.tn5250j.tools.encoder.EncodeComponent.Encoding

Enclosing class:

EncodeComponent

public static class EncodeComponent.Encoding
extends Object

Class used to enumerate valid encodings

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Encoder	getEncoder() Return an encoder for this encoding type.
String	getFailureMessage() Message to return about possible reasons for encoder load failure (i.e. getEncoder() returns null)
String	getLongName() Return the long name of the supported encoding type
String	getShortName() Return the short brief name of the supported encoding type
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(String short_name,
                String long_name,
                String encoder_class,
                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 String getShortName()

Return the short brief name of the supported encoding type

Returns:

string

getLongName

public String getLongName()

Return the long name of the supported encoding type

Returns:

string

toString

public String toString()

Returns a string representation bassed on the long and short name of the Encoder.

Overrides:

toString in class Object

Returns:

string

getFailureMessage

public 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