util.program

Class AbstractPluginProgramFormating

java.lang.Object

util.program.AbstractPluginProgramFormating

Direct Known Subclasses:

GlobalPluginProgramFormating, LocalPluginProgramFormating

public abstract class AbstractPluginProgramFormating
extends Object

A class for a program configuration setting. This is the super class of global and local program configurations.

Since:

2.5.1

Author:

René Mach

Constructor Summary

Constructors

Constructor and Description
AbstractPluginProgramFormating()

Method Summary

Methods

Modifier and Type	Method and Description
abstract String	getContentValue() Gets the value for the content formating
abstract String	getEncodingValue() Gets the value for the formating
abstract String	getId() Gets the id of this instance.
abstract String	getName() Gets the name of this configuration
abstract String	getTitleValue() Gets the value for title formating
abstract boolean	isValid() Gets if the configuration is valid.
protected abstract void	loadData(ObjectInputStream in)
static AbstractPluginProgramFormating	readData(ObjectInputStream in) Creates an instance of this class from an ObjectInputStream.
protected abstract void	storeData(ObjectOutputStream out)
void	writeData(ObjectOutputStream out) Saves the information about the program configuration values in an ObjectOutputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPluginProgramFormating

public AbstractPluginProgramFormating()

Method Detail

getName

public abstract String getName()

Gets the name of this configuration

Returns:

The name of this configuration

getTitleValue

public abstract String getTitleValue()

Gets the value for title formating

Returns:

The value for title formating

getContentValue

public abstract String getContentValue()

Gets the value for the content formating

Returns:

The value for the content formating

getEncodingValue

public abstract String getEncodingValue()

Gets the value for the formating

Returns:

The value for the formating

readData

public static final AbstractPluginProgramFormating readData(ObjectInputStream in)
                                                     throws IOException,
                                                            ClassNotFoundException

Creates an instance of this class from an ObjectInputStream.

Parameters:

in - The stream to read the values for the instance.

Returns:

The created instance or null if the instance could not be created.

Throws:

IOException - Thrown if something goes wrong;

ClassNotFoundException - Thrown if something goes wrong;

writeData

public final void writeData(ObjectOutputStream out)
                     throws IOException

Saves the information about the program configuration values in an ObjectOutputStream.

Parameters:

out - The stream to write the data to.

Throws:

IOException - Thrown if something goes wrong.

storeData

protected abstract void storeData(ObjectOutputStream out)
                           throws IOException

Throws:

IOException

loadData

protected abstract void loadData(ObjectInputStream in)
                          throws IOException,
                                 ClassNotFoundException

Throws:

IOException

ClassNotFoundException

isValid

public abstract boolean isValid()

Gets if the configuration is valid.

Returns:

If the configuration is valid

getId

public abstract String getId()

Gets the id of this instance.

Returns:

The id of this instance.