org.povclipse2.property.megapovxrs

Class CopyPattern

java.lang.Object

org.povclipse2.property.megapovxrs.CopyPattern

All Implemented Interfaces:

java.lang.Cloneable, IXmlProvider

public class CopyPattern
extends java.lang.Object
implements IXmlProvider, java.lang.Cloneable

Bean for storing the copy pattern data.
Performs XML serialization and deserialization as well.

Author:

Wolfgang Möstl

Field Summary

Fields

Modifier and Type	Field and Description
static int	OVERWRITE_ALLWAYS
static int	OVERWRITE_IF_CHANGED
static java.lang.String	OVERWRITE_RANGE

Constructor Summary

Constructors

Constructor and Description
CopyPattern() Constructor, sets the id to the long value representing the actual system time.

Method Summary

Modifier and Type	Method and Description
CopyPattern	clone()
boolean	equals(java.lang.Object obj)
void	fromXml(Element element) Deserializes the given JDOM Element adn stores it's content in the bean.
static CopyPattern	fromXML(Element element)
long	getId()
java.lang.String	getName()
int	getOverwrite()
java.lang.String	getPattern()
void	setName(java.lang.String name)
void	setOverwrite(int overwrite)
void	setPattern(java.lang.String pattern)
Element	toXML() Serializes the bean into an XML representation.

Methods inherited from class java.lang.Object

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

Field Detail

OVERWRITE_ALLWAYS

public static final int OVERWRITE_ALLWAYS

See Also:

Constant Field Values

OVERWRITE_IF_CHANGED

public static final int OVERWRITE_IF_CHANGED

See Also:

Constant Field Values

OVERWRITE_RANGE

public static final java.lang.String OVERWRITE_RANGE

See Also:

Constant Field Values

Constructor Detail

CopyPattern

public CopyPattern()

Constructor, sets the id to the long value representing the actual system time.

Method Detail

getName

public java.lang.String getName()

Returns:

The copy pattern name

setName

public void setName(java.lang.String name)

Parameters:

name - The name of the copy pattern

getOverwrite

public int getOverwrite()

Returns:

The overwrite strategy, one of the OVERWRITE_* constants.

setOverwrite

public void setOverwrite(int overwrite)

Parameters:

overwrite - The overwrite strategy to be used. Set ONLY one of the OVERWRITE_* constants!

getPattern

public java.lang.String getPattern()

Returns:

The copy pattern.

setPattern

public void setPattern(java.lang.String pattern)

Parameters:

pattern - The copy pattern to be used when copying files to the MegaPOV XRS servers.

fromXML

public static CopyPattern fromXML(Element element)
                           throws PovClipsePreferenceException

Parameters:

element - A JDOM Element representing the data of this bean.

Returns:

A new instance of this class being initialized with the given Element values.

Throws:

PovClipsePreferenceException - If the element could be be parsed.

fromXml

public void fromXml(Element element)
             throws PovClipsePreferenceException

Description copied from interface: IXmlProvider

Deserializes the given JDOM Element adn stores it's content in the bean.

Specified by:

fromXml in interface IXmlProvider

Parameters:

element - A JDOM Element whos data is to be used.

Throws:

PovClipsePreferenceException - if the given JDOM Element could not be parsed.

See Also:

com.wm.povclipse.property.megapovxrs.IXmlProvider#fromXml(org.jdom.Element)

toXML

public Element toXML()

Description copied from interface: IXmlProvider

Serializes the bean into an XML representation.

Specified by:

toXML in interface IXmlProvider

Returns:

An A JDOM Element representing the bean. This Element can be used to deserialize the XML using the method fromXml(Element element).

See Also:

com.wm.povclipse.property.megapovxrs.IXmlProvider#toXML()

getId

public long getId()

Returns:

The copy pattern id.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

clone

public CopyPattern clone()

Overrides:

clone in class java.lang.Object

Returns:

A perfect clone of this object, using a newly created ID.

See Also:

Object.clone()