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

Interface IArtifact

All Superinterfaces:

IVilType

All Known Subinterfaces:

IFileSystemArtifact, IRuntimeArtifact

All Known Implementing Classes:

AbstractJavaStatement, AlternativeFragment, ClassFileArtifact, ComponentArtifact, CompositeArtifact, CompositeFragmentArtifact, FileArtifact, FolderArtifact, FragmentArtifact, JavaAnnotation, JavaAssignment, JavaAttribute, JavaCall, JavaClass, JavaFileArtifact, JavaFragmentArtifact, JavaImport, JavaMethod, JavaPackage, JavaParentFragmentArtifact, JavaQualifiedName, MultipleSelectionFragment, OptionalityFragment, SimpleArtifact, VariabilityFragment, VtlFileArtifact, XmlAttribute, XmlComment, XmlElement, XmlFileArtifact, XmlNode, XmlRootElement

public interface IArtifact
extends IVilType

Represents a generic artifact.

Author:

Holger Eichelberger

Method Summary

Modifier and Type	Method	Description
void	accept(IArtifactVisitor visitor)	Visits this artifact (and dependent on the visitor also contained artifacts and fragments) using the given visitor.
void	delete()	Deletes this artifact.
boolean	exists()	Returns whether this artifact is exists.
Binary	getBinary()	Returns the binary representation of the contents of this artifact for manipulation.
java.lang.String	getName()	Returns the name of this artifact.
Text	getText()	Returns the textual representation of the contents of this artifact for manipulation.
long	lastModification()	Returns the last modification timestamp of this artifact.
void	rename(java.lang.String name)	Renames this artifact.
void	store()	Stores this artifact in case of changes.
void	update()	Called if the underlying real artifact may have been updated, e.g., by overriding it by another file.

Method Detail

delete

void delete()
     throws VilException

Deletes this artifact.

Throws:

VilException - in case of serious problems so that this operation cannot continue

getName

java.lang.String getName()
                  throws VilException

Returns the name of this artifact.

Returns:

the name of this artifact

Throws:

VilException - in case of serious problems so that this operation cannot continue

rename

void rename(java.lang.String name)
     throws VilException

Renames this artifact.

Parameters:

name - the new name of this artifact

Throws:

VilException - in case of serious problems so that this operation cannot continue

getText

Text getText()
      throws VilException

Returns the textual representation of the contents of this artifact for manipulation. In case of binary artifacts, the returned object may be empty.

Returns:

the textual representation of the contents

Throws:

VilException - in case of obtaining the representation causes serious problems

getBinary

Binary getBinary()
          throws VilException

Returns the binary representation of the contents of this artifact for manipulation.

Returns:

the binary representation of the contents

Throws:

VilException - in case of obtaining the representation causes serious problems

accept

void accept(IArtifactVisitor visitor)

Visits this artifact (and dependent on the visitor also contained artifacts and fragments) using the given visitor.

Parameters:

visitor - the visitor used for visiting this artifact

update

void update()
     throws VilException

Called if the underlying real artifact may have been updated, e.g., by overriding it by another file.

Throws:

VilException - in case that updating fails

lastModification

long lastModification()

Returns the last modification timestamp of this artifact.

Returns:

the last modification timestamp, 0 if unknown

exists

boolean exists()

Returns whether this artifact is exists.

Returns:

true if this artifact exists, false else

store

void store()
    throws VilException

Stores this artifact in case of changes.

Throws:

VilException - in case of problems storing this artifact