com.exalead.mercury.mami.resources.v10

Class UploadLocalFile

java.lang.Object

com.exalead.mercury.mami.resources.v10.FormatType

com.exalead.mercury.mami.resources.v10.Upload

com.exalead.mercury.mami.resources.v10.UploadLocalFile

All Implemented Interfaces:

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

public class UploadLocalFile
extends Upload
implements com.exalead.util.Checkable, java.io.Serializable

Uploads a resource with its path

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.mercury.mami.resources.v10.FormatType

FormatType.Format

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	path

Fields inherited from class com.exalead.mercury.mami.resources.v10.Upload

author, DEFAULT_MAX_GEN_KEPT, DEFAULT_PUBLISH, DEFAULT_UPDATE, description, maxGenKept, name, publish, update

Fields inherited from class com.exalead.mercury.mami.resources.v10.FormatType

format

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this UploadLocalFile.
static UploadLocalFile	fromString(java.lang.String s) String representation of this UploadLocalFile.
java.lang.String	getPath()
UploadLocalFile	makeCopy() Creates and returns a deep copy of this UploadLocalFile.
static UploadLocalFile	readFrom(java.io.InputStream is) Read this UploadLocalFile from an XML fragment.
void	setPath(java.lang.String path)
java.lang.String	toString() String representation of this UploadLocalFile.
UploadLocalFile	withAuthor(java.lang.String author)
UploadLocalFile	withDescription(java.lang.String description)
UploadLocalFile	withFormat(java.lang.String format)
UploadLocalFile	withMaxGenKept(int maxGenKept)
UploadLocalFile	withMaxGenKept(java.lang.Integer maxGenKept)
UploadLocalFile	withName(java.lang.String name)
UploadLocalFile	withPath(java.lang.String path)
UploadLocalFile	withPublish(boolean publish)
UploadLocalFile	withPublish(java.lang.Boolean publish)
UploadLocalFile	withUpdate(boolean update)
UploadLocalFile	withUpdate(java.lang.Boolean update)
void	writeTo(java.io.OutputStream os) Write this UploadLocalFile as an XML fragment

Methods inherited from class com.exalead.mercury.mami.resources.v10.Upload

getAuthor, getDescription, getMaxGenKept, getName, isPublish, isUpdate, setAuthor, setDescription, setMaxGenKept, setName, setPublish, setUpdate

Methods inherited from class com.exalead.mercury.mami.resources.v10.FormatType

getFormat, getFormatAsEnum, isA, isOneOf, setFormat, setFormat

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

Constructor Detail

UploadLocalFile

public UploadLocalFile()

UploadLocalFile

public UploadLocalFile(UploadLocalFile o)

Copy constructor

Method Detail

withName

public UploadLocalFile withName(java.lang.String name)

Overrides:

withName in class Upload

withAuthor

public UploadLocalFile withAuthor(java.lang.String author)

Overrides:

withAuthor in class Upload

withDescription

public UploadLocalFile withDescription(java.lang.String description)

Overrides:

withDescription in class Upload

withPublish

public UploadLocalFile withPublish(boolean publish)

Overrides:

withPublish in class Upload

withPublish

public UploadLocalFile withPublish(java.lang.Boolean publish)

Overrides:

withPublish in class Upload

withUpdate

public UploadLocalFile withUpdate(boolean update)

Overrides:

withUpdate in class Upload

withUpdate

public UploadLocalFile withUpdate(java.lang.Boolean update)

Overrides:

withUpdate in class Upload

withMaxGenKept

public UploadLocalFile withMaxGenKept(int maxGenKept)

Overrides:

withMaxGenKept in class Upload

withMaxGenKept

public UploadLocalFile withMaxGenKept(java.lang.Integer maxGenKept)

Overrides:

withMaxGenKept in class Upload

withFormat

public UploadLocalFile withFormat(java.lang.String format)

Overrides:

withFormat in class Upload

setPath

public void setPath(java.lang.String path)

getPath

public java.lang.String getPath()

withPath

public UploadLocalFile withPath(java.lang.String path)

makeCopy

public UploadLocalFile makeCopy()

Creates and returns a deep copy of this UploadLocalFile.

Overrides:

makeCopy in class Upload

readFrom

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

Read this UploadLocalFile 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 UploadLocalFile as an XML fragment

Overrides:

writeTo in class Upload

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this UploadLocalFile.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this UploadLocalFile.

Overrides:

toString in class Upload

check

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

Checks this UploadLocalFile.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class Upload

Throws:

com.exalead.util.TypedException