util.program

Class LocalPluginProgramFormating

java.lang.Object

util.program.AbstractPluginProgramFormating

util.program.LocalPluginProgramFormating

public class LocalPluginProgramFormating
extends AbstractPluginProgramFormating

Settings for program formating. This is the class for using for creating configuration used only by the plugin which creates the instance of this class.

Since:

2.5.1

Author:

René Mach

Constructor Summary

Constructors

Constructor and Description
LocalPluginProgramFormating() Creates an empty instance of this class, for example for loading the values from an ObjectInputStream.
LocalPluginProgramFormating(String name, String titleValue, String contentValue, String encodingValue) Creates an instance of a program configuration.
LocalPluginProgramFormating(String id, String name, String titleValue, String contentValue, String encodingValue) Creates an instance of a program configuration.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getContentValue() Gets the value for the content formating
String	getEncodingValue() Gets the value for the formating
String	getId() Gets the id of this instance.
String	getName() Gets the name of this configuration
String	getTitleValue() Gets the value for title formating
boolean	isValid() Gets if the configuration is valid.
protected void	loadData(ObjectInputStream in) Creates an instance of a ProgramConfiguration from an ObjetcInputStream-
void	setContentValue(String value) Sets the content formating value
void	setEncodingValue(String value) Sets the encoding value of this configuraion
void	setName(String value) Sets the name of this configuration
void	setTitleValue(String value) Sets the title formating value
protected void	storeData(ObjectOutputStream out) Saves this configuration in an ObjectOutputStream
String	toString()

Methods inherited from class util.program.AbstractPluginProgramFormating

readData, writeData

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalPluginProgramFormating

public LocalPluginProgramFormating()

Creates an empty instance of this class, for example for loading the values from an ObjectInputStream.

LocalPluginProgramFormating

public LocalPluginProgramFormating(String id,
                           String name,
                           String titleValue,
                           String contentValue,
                           String encodingValue)

Creates an instance of a program configuration.

Parameters:

id - The id of this formating.

name - The name of the configuration.

titleValue - The value for the title configuration.

contentValue - The value for the content.

encodingValue - The encoding value.

LocalPluginProgramFormating

public LocalPluginProgramFormating(String name,
                           String titleValue,
                           String contentValue,
                           String encodingValue)

Creates an instance of a program configuration.

Parameters:

name - The name of the configuration.

titleValue - The value for the title configuration.

contentValue - The value for the content.

encodingValue - The encoding value.

Method Detail

getName

public String getName()

Gets the name of this configuration

Specified by:

getName in class AbstractPluginProgramFormating

Returns:

The name of this configuration

getTitleValue

public String getTitleValue()

Gets the value for title formating

Specified by:

getTitleValue in class AbstractPluginProgramFormating

Returns:

The value for title formating

getContentValue

public String getContentValue()

Gets the value for the content formating

Specified by:

getContentValue in class AbstractPluginProgramFormating

Returns:

The value for the content formating

getEncodingValue

public String getEncodingValue()

Gets the value for the formating

Specified by:

getEncodingValue in class AbstractPluginProgramFormating

Returns:

The value for the formating

setName

public void setName(String value)

Sets the name of this configuration

Parameters:

value - The new name

setTitleValue

public void setTitleValue(String value)

Sets the title formating value

Parameters:

value - The new title value

setContentValue

public void setContentValue(String value)

Sets the content formating value

Parameters:

value - The new content value

setEncodingValue

public void setEncodingValue(String value)

Sets the encoding value of this configuraion

Parameters:

value - The new encoding

loadData

protected void loadData(ObjectInputStream in)
                 throws IOException,
                        ClassNotFoundException

Creates an instance of a ProgramConfiguration from an ObjetcInputStream-

Specified by:

loadData in class AbstractPluginProgramFormating

Parameters:

in - The stream to read the values from

Throws:

IOException - Thrown if something goes wrong

ClassNotFoundException - Thrown if something goes wrong

storeData

protected void storeData(ObjectOutputStream out)
                  throws IOException

Saves this configuration in an ObjectOutputStream

Specified by:

storeData in class AbstractPluginProgramFormating

Parameters:

out - The stream to save the values in

Throws:

IOException - Thrown if something goes wrong

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

isValid

public boolean isValid()

Description copied from class: AbstractPluginProgramFormating

Gets if the configuration is valid.

Specified by:

isValid in class AbstractPluginProgramFormating

Returns:

If the configuration is valid

getId

public String getId()

Description copied from class: AbstractPluginProgramFormating

Gets the id of this instance.

Specified by:

getId in class AbstractPluginProgramFormating

Returns:

The id of this instance.