com.hds.hcpaw.fss.api.model

Class FileVersionEntry

java.lang.Object

com.hds.hcpaw.fss.api.model.BaseFssApiResource

com.hds.hcpaw.fss.api.model.FileVersionEntry

public abstract class FileVersionEntry
extends BaseFssApiResource

Represents a file or folder and holds information (metadata) about the file or folder.

Field Summary

Fields inherited from class com.hds.hcpaw.fss.api.model.BaseFssApiResource

UTF_8

Method Summary

Modifier and Type	Method and Description
static FileVersionEntry	create(FssApiVersion apiVersion, java.lang.String event, java.lang.String username, java.lang.Long size, java.lang.Long timestamp, int nanos, java.lang.Short tsExtra, java.lang.Boolean currentVersion, java.lang.String etag, java.lang.String eventArg) Returns a versioned FileVersionEntry that is compatible with the specified apiVersion.
boolean	equals(java.lang.Object o)
java.lang.String	getEtag() Returns the etag associated with the version
java.lang.String	getEvent() Returns the event type
java.lang.String	getEventArg() Returns argument associated with the event string
static java.lang.Class<? extends FileVersionEntry>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the FileVersionEntry that corresponds to the specified apiVersion.
int	getNanos() Returns the nanoseconds associated with the file time
java.lang.Long	getSize() Returns the size of the version in string form
java.lang.Long	getTimestamp() Returns the time that the entry was created
java.lang.Short	getTsExtra() Returns the tsExtra value associated with the version
java.lang.String	getUsername() Returns the name of the user that created this version entry
int	hashCode()
java.lang.Boolean	isCurrentVersion() Returns whether or not this version represents the current version of the file
void	validate(java.lang.String fieldName, BaseFssApiResource parent) Validates this object.

Methods inherited from class com.hds.hcpaw.fss.api.model.BaseFssApiResource

badValue, badValue, fromJson, toJson, toJson, toString, validate, validateFieldInRange, validateFieldInRange, validateFieldIsNull, validateFieldNotNull, validateLocale, validateOptionalField, validateOptionalFieldList, validateRequiredField, validateRequiredFieldList, writeToOutputStream

Methods inherited from class java.lang.Object

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

Method Detail

getFssApiClass

public static java.lang.Class<? extends FileVersionEntry> getFssApiClass(FssApiVersion apiVersion)

Returns the Class of the FileVersionEntry that corresponds to the specified apiVersion.

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the entry that corresponds to the specified apiVersion

create

public static FileVersionEntry create(FssApiVersion apiVersion,
                                      java.lang.String event,
                                      java.lang.String username,
                                      java.lang.Long size,
                                      java.lang.Long timestamp,
                                      int nanos,
                                      java.lang.Short tsExtra,
                                      java.lang.Boolean currentVersion,
                                      java.lang.String etag,
                                      java.lang.String eventArg)
                               throws AwUnsupportedApiVersionException

Returns a versioned FileVersionEntry that is compatible with the specified apiVersion.

Parameters:

event - Type of file version event

username - Name of user that made the version change

size - size (in bytes) of the entry. This parameter is only applicable to files.

timestamp - Time of the file version event.

nanos - Nanoseconds associated with the timestamp

tsExtra - Timestamp qualifier

currentVersion - True if this VersionEntry represents the current version of the file

etag - The etag for this version of the file

Returns:

a versioned instance of FileVersionEntry that supports the specified apiVersion

Throws:

AwUnsupportedApiVersionException - The specified API version is not supported

getEvent

public java.lang.String getEvent()

Returns the event type

Returns:

the event type

getUsername

public java.lang.String getUsername()

Returns the name of the user that created this version entry

Returns:

name of the user that created this version entry

getSize

public java.lang.Long getSize()

Returns the size of the version in string form

Returns:

size of the version in string form

isCurrentVersion

public java.lang.Boolean isCurrentVersion()

Returns whether or not this version represents the current version of the file

Returns:

whether or not this version represents the current version of the file

getTimestamp

public java.lang.Long getTimestamp()

Returns the time that the entry was created

Returns:

time that the entry was created

getNanos

public int getNanos()

Returns the nanoseconds associated with the file time

Returns:

the nanoseconds associated with the file time

getTsExtra

public java.lang.Short getTsExtra()

Returns the tsExtra value associated with the version

Returns:

the tsExtra value associated with the version

getEtag

public java.lang.String getEtag()

Returns the etag associated with the version

Returns:

the etag value associated with the version

getEventArg

public java.lang.String getEventArg()

Returns argument associated with the event string

Returns:

the argument associated with the event string

validate

public void validate(java.lang.String fieldName,
                     BaseFssApiResource parent)
              throws AwJsonException

Validates this object.

Specified by:

validate in class BaseFssApiResource

Parameters:

fieldName - name of this object in the parent (containing) object. If this object is a top-level object (not contained within another object), then enter null for this parameter

parent - parent (containing) object that contains the object specified in the fieldName parameter. If this object is a top-level object (not contained within another object), then enter null for this parameter

Throws:

AwJsonException - if any validation errors occur

See Also:

BaseFssApiResource.validate(String, BaseFssApiResource)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object