com.exalead.mercury.mami.resources.v10

Class PreparedVersion

java.lang.Object

com.exalead.mercury.mami.resources.v10.PreparedVersion

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class PreparedVersion
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

PrepareNewVersion's result

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	author
java.lang.String	comment
static int	DEFAULT_MAX_GEN_KEPT
int	maxGenKept
java.lang.String	name
java.lang.String	path

Constructor Summary

Constructors

Constructor and Description
PreparedVersion()
PreparedVersion(PreparedVersion o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this PreparedVersion.
static PreparedVersion	fromString(java.lang.String s) String representation of this PreparedVersion.
java.lang.String	getAuthor() Author of this resource
java.lang.String	getComment() Comment attached to this version of the resource.
int	getMaxGenKept() Maximum number of generation kept for this resource.
java.lang.String	getName() Name of the resource
java.lang.String	getPath() The path to new version
PreparedVersion	makeCopy() Creates and returns a deep copy of this PreparedVersion.
static PreparedVersion	readFrom(java.io.InputStream is) Read this PreparedVersion from an XML fragment.
void	setAuthor(java.lang.String author) Author of this resource
void	setComment(java.lang.String comment) Comment attached to this version of the resource.
void	setMaxGenKept(int maxGenKept) Maximum number of generation kept for this resource.
void	setName(java.lang.String name) Name of the resource
void	setPath(java.lang.String path) The path to new version
java.lang.String	toString() String representation of this PreparedVersion.
PreparedVersion	withAuthor(java.lang.String author)
PreparedVersion	withComment(java.lang.String comment)
PreparedVersion	withMaxGenKept(int maxGenKept)
PreparedVersion	withMaxGenKept(java.lang.Integer maxGenKept)
PreparedVersion	withName(java.lang.String name)
PreparedVersion	withPath(java.lang.String path)
void	writeTo(java.io.OutputStream os) Write this PreparedVersion as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

path

public java.lang.String path

name

public java.lang.String name

author

public java.lang.String author

comment

public java.lang.String comment

maxGenKept

public int maxGenKept

DEFAULT_MAX_GEN_KEPT

public static final int DEFAULT_MAX_GEN_KEPT

See Also:

Constant Field Values

Constructor Detail

PreparedVersion

public PreparedVersion()

PreparedVersion

public PreparedVersion(PreparedVersion o)

Copy constructor

Method Detail

setPath

public void setPath(java.lang.String path)

The path to new version

getPath

public java.lang.String getPath()

The path to new version

withPath

public PreparedVersion withPath(java.lang.String path)

setName

public void setName(java.lang.String name)

Name of the resource

getName

public java.lang.String getName()

Name of the resource

withName

public PreparedVersion withName(java.lang.String name)

setAuthor

public void setAuthor(java.lang.String author)

Author of this resource

getAuthor

public java.lang.String getAuthor()

Author of this resource

withAuthor

public PreparedVersion withAuthor(java.lang.String author)

setComment

public void setComment(java.lang.String comment)

Comment attached to this version of the resource.

getComment

public java.lang.String getComment()

Comment attached to this version of the resource.

withComment

public PreparedVersion withComment(java.lang.String comment)

setMaxGenKept

public void setMaxGenKept(int maxGenKept)

Maximum number of generation kept for this resource. 0 means no GC.

getMaxGenKept

public int getMaxGenKept()

Maximum number of generation kept for this resource. 0 means no GC.

withMaxGenKept

public PreparedVersion withMaxGenKept(int maxGenKept)

withMaxGenKept

public PreparedVersion withMaxGenKept(java.lang.Integer maxGenKept)

makeCopy

public PreparedVersion makeCopy()

Creates and returns a deep copy of this PreparedVersion.

readFrom

public static PreparedVersion readFrom(java.io.InputStream is)
                                throws javax.xml.bind.JAXBException

Read this PreparedVersion from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this PreparedVersion as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static PreparedVersion fromString(java.lang.String s)
                                  throws javax.xml.bind.JAXBException,
                                         java.io.UnsupportedEncodingException

String representation of this PreparedVersion.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this PreparedVersion.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this PreparedVersion.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException