ConQAT 2.6

edu.tum.cs.conqat.filesystem.scope
Interface IFileSystemElement

All Superinterfaces:
IConQATNode, IDeepCloneable, IRemovableConQATNode
All Known Subinterfaces:
IJavaClassElement, IJavaElement, IJavaRootElement, ISimulinkElement, ISourceCodeElement
All Known Implementing Classes:
CloneDetectionResultElement, FileSystemElement, FileSystemParameterObjectBase, FileSystemParameterObjectListBase, JavaClassElement, JavaElementBase, JavaPackageElement, JavaRootElement, SimulinkElement, SimulinkModelElement, SourceCodeElement

public interface IFileSystemElement
extends IRemovableConQATNode

A file system element represents an element that may or may not be physically present on a disk. Elements distinguish between a local name which is atomic and path that describes the path from the root to this element.

Rating:
GREEN Hash: 347EAE03333D92CBECC64B125B888CA3

Method Summary
 IFileSystemElement deepClone()
           Deep clone of this node.
 IFileSystemElement[] getChildren()
          Returns all children of this node.
 Charset getEncoding()
          Get encoding of file element.
 CanonicalFile getFile()
          Get the underlying file system resource, or null if this node has no file system representation.
 String getId()
          Returns the ID of the node.
 IFileSystemElement getParent()
          Returns the parent node of this node, or null if this is the root node.
 
Methods inherited from interface edu.tum.cs.conqat.commons.node.IRemovableConQATNode
remove
 
Methods inherited from interface edu.tum.cs.conqat.commons.node.IConQATNode
getName, getValue, hasChildren, setValue
 

Method Detail

getFile

CanonicalFile getFile()
Get the underlying file system resource, or null if this node has no file system representation.


getChildren

IFileSystemElement[] getChildren()
Returns all children of this node. The return value is an array, so subclasses can use covariant return types. If IConQATNode.hasChildren() is false this may return null.

Redeclared for covariant return type. Override for more specific return type.

Specified by:
getChildren in interface IConQATNode
Specified by:
getChildren in interface IRemovableConQATNode

getParent

IFileSystemElement getParent()
Returns the parent node of this node, or null if this is the root node. Override for more specific return type.

Specified by:
getParent in interface IConQATNode

getId

String getId()
Returns the ID of the node. This should be a string which is globally unique for the entire tree. Often the ID is composed of the name of the node and the nodes of all ancestors, although this is not required. For file system elements the id corresponds to the canonical path.

Specified by:
getId in interface IConQATNode

getEncoding

Charset getEncoding()
Get encoding of file element.


deepClone

IFileSystemElement deepClone()
                             throws DeepCloneException

Deep clone of this node. This method is redefined because of the covariant return type.

Redeclared for covariant return type.

Specified by:
deepClone in interface IConQATNode
Specified by:
deepClone in interface IDeepCloneable
Specified by:
deepClone in interface IRemovableConQATNode
Throws:
DeepCloneException

ConQAT 2.6

© 2005—2010 Technische Universität München