Package net.ssehub.easy.instantiation.core.model.artifactModel

Interface IFileSystemArtifact

All Superinterfaces:

IArtifact, IStringValueProvider, IVilType

All Known Implementing Classes:

ClassFileArtifact, FileArtifact, FolderArtifact, JavaFileArtifact, VtlFileArtifact, XmlFileArtifact

public interface IFileSystemArtifact
extends IArtifact, IStringValueProvider

Represents a file system artifact, i.e., a real-world entity in a file system.

Author:

Holger Eichelberger

Nested Class Summary

Nested classes/interfaces inherited from interface net.ssehub.easy.instantiation.core.model.vilTypes.IStringValueProvider

IStringValueProvider.StringComparator

Method Summary

Modifier and Type	Method	Description
Set<IFileSystemArtifact>	copy(IFileSystemArtifact target)	Copy this artifact.
Path	getPath()	Returns the path artifact representing the path to this file system artifact.
boolean	isTemporary()	Returns whether this artifact is (considered to be) a temporary artifact.
Set<IFileSystemArtifact>	move(IFileSystemArtifact target)	Move this artifact.
void	setExecutable(boolean ownerOnly)	Enables the (operation system specific) execution flag for this artifact.

Methods inherited from interface net.ssehub.easy.instantiation.core.model.artifactModel.IArtifact

accept, delete, exists, getBinary, getName, getText, lastModification, rename, store, update

Methods inherited from interface net.ssehub.easy.instantiation.core.model.vilTypes.IStringValueProvider

getStringValue

Method Detail

getPath

Path getPath()
      throws VilException

Returns the path artifact representing the path to this file system artifact. The absolute and simple name can be obtained from the path. Note that IArtifact.getName() will return the simple name of this artifact.

Returns:

the path

Throws:

VilException - in case of serious problems

move

Set<IFileSystemArtifact> move(IFileSystemArtifact target)
                       throws VilException

Move this artifact.

Parameters:

target - the target artifact. In case of a file, the target is supposed to be overridden. In case of a directory, this artifact shall after this operation be part of the directory.

Returns:

this (for chained operations)

Throws:

VilException - in case of serious problems

copy

Set<IFileSystemArtifact> copy(IFileSystemArtifact target)
                       throws VilException

Copy this artifact.

Parameters:

target - the target artifact. In case of a file, the target is supposed to be overridden by a copy of this artifact. In case of a directory, a copy of this artifact shall after this operation be part of the directory.

Returns:

this (for chained operations)

Throws:

VilException - in case of serious problems

setExecutable

void setExecutable(boolean ownerOnly)
            throws VilException

Enables the (operation system specific) execution flag for this artifact.

Parameters:

ownerOnly - whether all users or just the owner shall be allowed to exectue this artifact

Throws:

VilException - if the executable flag cannot be set.

isTemporary

boolean isTemporary()

Returns whether this artifact is (considered to be) a temporary artifact.

Returns:

true if it is temporary, false else