org.electrocodeogram.cpc.core.api.data
Interface ICloneFile

All Superinterfaces:

java.lang.Cloneable, org.eclipse.core.runtime.IAdaptable, ICloneDataElement, ICloneObject, java.io.Serializable

All Known Subinterfaces:

ICloneFileInterfaces, ICreatorCloneFile, IRemoteStoreCloneFile

public interface ICloneFile
extends ICloneObject

Public interface for all clone file data objects.

Any implementation needs to implement ICloneFileInterfaces. Implementing only ICloneFile is not enough!

This interface lists all methods which are available to all CPC plugins and 3rd party contributions.

Additional methods are defined by more specific sub-interfaces which belong to individual CPC plugins and are to be considered private.
Any CPC plugin other than the one designated in the sub-interface API must not access such methods.

Author:

vw

See Also:

ICloneFileInterfaces

Field Summary

static java.lang.String

PERSISTENCE_CLASS_IDENTIFIER IStatefulObject persistence class identifier, value: "clone_file"

Fields inherited from interface org.electrocodeogram.cpc.core.api.data.ICloneObject

PERSISTENCE_OBJECT_IDENTIFIER

Method Summary

long	getModificationDate() Retrieves the file modification timestamp at the point in time of the last save operation.
java.lang.String	getPath() Retrieves the project relative path of this file.
java.lang.String	getProject() Retrieves the project name of this file.
long	getSize() Retrieves the file size at the point in time of the last save operation.

Methods inherited from interface org.electrocodeogram.cpc.core.api.data.ICloneObject

addExtension, clone, equals, equalsAll, getExtension, getExtensions, getUuid, hasExtensions, hashCode, isMarked, removeExtension, removeExtension, setMarked, toString

Methods inherited from interface org.electrocodeogram.cpc.core.api.data.ICloneDataElement

isSealed, seal

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Field Detail

PERSISTENCE_CLASS_IDENTIFIER

static final java.lang.String PERSISTENCE_CLASS_IDENTIFIER

IStatefulObject persistence class identifier, value: "clone_file"

See Also:

Constant Field Values

Method Detail

getProject

java.lang.String getProject()

Retrieves the project name of this file.

Returns:

project which contains the resource, never null.

getPath

java.lang.String getPath()

Retrieves the project relative path of this file.

Returns:

path of resource, relative to project directory. Contains the file name, but not the project name. Never null.

getSize

long getSize()

Retrieves the file size at the point in time of the last save operation.

Returns:

the file size of the corresponding file on disk in bytes.

getModificationDate

long getModificationDate()

Retrieves the file modification timestamp at the point in time of the last save operation.
This value may not always be available.

Returns:

the file modification timestamp of the corresponding file on disk in bytes.