edu.uci.isr.xarch.javasourcecode
Interface IJavaSourceCodeImplementation

All Superinterfaces:

IImplementation, IXArchElement

All Known Implementing Classes:

JavaSourceCodeImplementationImpl

public interface IJavaSourceCodeImplementation

extends IImplementation, IXArchElement

Interface for accessing objects of the JavaSourceCodeImplementation xsi:type in the javasourcecode namespace. Extends and inherits the properties of the Implementation xsi:type.

Author:

xArch apigen

Field Summary

static XArchTypeMetadata

TYPE_METADATA

Fields inherited from interface edu.uci.isr.xarch.IXArchElement

DEPTH_INFINITY, DEPTH_ONE, DEPTH_ZERO

Method Summary

void	addRepositoryLocation(IRepositoryLocation newRepositoryLocation) Add a repositoryLocation to this JavaSourceCodeImplementation.
void	addRepositoryLocations(Collection repositoryLocations) Add a collection of repositoryLocations to this JavaSourceCodeImplementation.
void	addSourceCodeFile(IJavaSourceFile newSourceCodeFile) Add a sourceCodeFile to this JavaSourceCodeImplementation.
void	addSourceCodeFiles(Collection sourceCodeFiles) Add a collection of sourceCodeFiles to this JavaSourceCodeImplementation.
void	clearRepositoryLocations() Remove all repositoryLocations from this JavaSourceCodeImplementation.
void	clearSourceCodeFiles() Remove all sourceCodeFiles from this JavaSourceCodeImplementation.
void	clearSourceCodeManager() Clear the sourceCodeManager from this JavaSourceCodeImplementation.
Collection	getAllRepositoryLocations() Get all the repositoryLocations from this JavaSourceCodeImplementation.
Collection	getAllSourceCodeFiles() Get all the sourceCodeFiles from this JavaSourceCodeImplementation.
IJavaSourceCodeManager	getSourceCodeManager() Get the sourceCodeManager from this JavaSourceCodeImplementation.
boolean	hasAllRepositoryLocations(Collection repositoryLocationsToCheck) Determine if this JavaSourceCodeImplementation contains each element in the given set of repositoryLocations.
boolean	hasAllSourceCodeFiles(Collection sourceCodeFilesToCheck) Determine if this JavaSourceCodeImplementation contains each element in the given set of sourceCodeFiles.
boolean	hasRepositoryLocation(IRepositoryLocation repositoryLocationToCheck) Determine if this JavaSourceCodeImplementation contains a given repositoryLocation.
Collection	hasRepositoryLocations(Collection repositoryLocationsToCheck) Determine if this JavaSourceCodeImplementation contains the given set of repositoryLocations.
boolean	hasSourceCodeFile(IJavaSourceFile sourceCodeFileToCheck) Determine if this JavaSourceCodeImplementation contains a given sourceCodeFile.
Collection	hasSourceCodeFiles(Collection sourceCodeFilesToCheck) Determine if this JavaSourceCodeImplementation contains the given set of sourceCodeFiles.
boolean	hasSourceCodeManager(IJavaSourceCodeManager sourceCodeManagerToCheck) Determine if this JavaSourceCodeImplementation has the given sourceCodeManager
boolean	isEquivalent(IJavaSourceCodeImplementation JavaSourceCodeImplementationToCheck) Determine if another JavaSourceCodeImplementation is equivalent to this one, ignoring ID's.
void	removeRepositoryLocation(IRepositoryLocation repositoryLocationToRemove) Remove the given repositoryLocation from this JavaSourceCodeImplementation.
void	removeRepositoryLocations(Collection repositoryLocations) Remove all the given repositoryLocations from this JavaSourceCodeImplementation.
void	removeSourceCodeFile(IJavaSourceFile sourceCodeFileToRemove) Remove the given sourceCodeFile from this JavaSourceCodeImplementation.
void	removeSourceCodeFiles(Collection sourceCodeFiles) Remove all the given sourceCodeFiles from this JavaSourceCodeImplementation.
void	setSourceCodeManager(IJavaSourceCodeManager value) Set the sourceCodeManager for this JavaSourceCodeImplementation.

Methods inherited from interface edu.uci.isr.xarch.implementation.IImplementation

isEquivalent

Methods inherited from interface edu.uci.isr.xarch.IXArchElement

cloneElement, getInstanceMetadata, getTypeMetadata, getXArch, setXArch

Field Detail

TYPE_METADATA

public static final XArchTypeMetadata TYPE_METADATA

Method Detail

addSourceCodeFile

public void addSourceCodeFile(IJavaSourceFile newSourceCodeFile)

Add a sourceCodeFile to this JavaSourceCodeImplementation.

Parameters:

newSourceCodeFile - sourceCodeFile to add.

addSourceCodeFiles

public void addSourceCodeFiles(Collection sourceCodeFiles)

Add a collection of sourceCodeFiles to this JavaSourceCodeImplementation.

Parameters:

sourceCodeFiles - sourceCodeFiles to add.

clearSourceCodeFiles

public void clearSourceCodeFiles()

Remove all sourceCodeFiles from this JavaSourceCodeImplementation.

removeSourceCodeFile

public void removeSourceCodeFile(IJavaSourceFile sourceCodeFileToRemove)

Remove the given sourceCodeFile from this JavaSourceCodeImplementation. Matching is done by the isEquivalent(...) function.

Parameters:

sourceCodeFileToRemove - sourceCodeFile to remove.

removeSourceCodeFiles

public void removeSourceCodeFiles(Collection sourceCodeFiles)

Remove all the given sourceCodeFiles from this JavaSourceCodeImplementation. Matching is done by the isEquivalent(...) function.

Parameters:

sourceCodeFiles - sourceCodeFile to remove.

getAllSourceCodeFiles

public Collection getAllSourceCodeFiles()

Get all the sourceCodeFiles from this JavaSourceCodeImplementation.

Returns:

all sourceCodeFiles in this JavaSourceCodeImplementation.

hasSourceCodeFile

public boolean hasSourceCodeFile(IJavaSourceFile sourceCodeFileToCheck)

Determine if this JavaSourceCodeImplementation contains a given sourceCodeFile.

Returns:

true if this JavaSourceCodeImplementation contains the given sourceCodeFileToCheck, false otherwise.

hasSourceCodeFiles

public Collection hasSourceCodeFiles(Collection sourceCodeFilesToCheck)

Determine if this JavaSourceCodeImplementation contains the given set of sourceCodeFiles.

Parameters:

sourceCodeFilesToCheck - sourceCodeFiles to check for.

Returns:

Collection of java.lang.Boolean. If the i^th element in sourceCodeFiles was found, then the i^th element of the collection will be set to true, otherwise it will be set to false. Matching is done with the isEquivalent(...) method.

hasAllSourceCodeFiles

public boolean hasAllSourceCodeFiles(Collection sourceCodeFilesToCheck)

Determine if this JavaSourceCodeImplementation contains each element in the given set of sourceCodeFiles.

Parameters:

sourceCodeFilesToCheck - sourceCodeFiles to check for.

Returns:

true if every element in sourceCodeFiles is found in this JavaSourceCodeImplementation, false otherwise.

addRepositoryLocation

public void addRepositoryLocation(IRepositoryLocation newRepositoryLocation)

Add a repositoryLocation to this JavaSourceCodeImplementation.

Parameters:

newRepositoryLocation - repositoryLocation to add.

addRepositoryLocations

public void addRepositoryLocations(Collection repositoryLocations)

Add a collection of repositoryLocations to this JavaSourceCodeImplementation.

Parameters:

repositoryLocations - repositoryLocations to add.

clearRepositoryLocations

public void clearRepositoryLocations()

Remove all repositoryLocations from this JavaSourceCodeImplementation.

removeRepositoryLocation

public void removeRepositoryLocation(IRepositoryLocation repositoryLocationToRemove)

Remove the given repositoryLocation from this JavaSourceCodeImplementation. Matching is done by the isEquivalent(...) function.

Parameters:

repositoryLocationToRemove - repositoryLocation to remove.

removeRepositoryLocations

public void removeRepositoryLocations(Collection repositoryLocations)

Remove all the given repositoryLocations from this JavaSourceCodeImplementation. Matching is done by the isEquivalent(...) function.

Parameters:

repositoryLocations - repositoryLocation to remove.

getAllRepositoryLocations

public Collection getAllRepositoryLocations()

Get all the repositoryLocations from this JavaSourceCodeImplementation.

Returns:

all repositoryLocations in this JavaSourceCodeImplementation.

hasRepositoryLocation

public boolean hasRepositoryLocation(IRepositoryLocation repositoryLocationToCheck)

Determine if this JavaSourceCodeImplementation contains a given repositoryLocation.

Returns:

true if this JavaSourceCodeImplementation contains the given repositoryLocationToCheck, false otherwise.

hasRepositoryLocations

public Collection hasRepositoryLocations(Collection repositoryLocationsToCheck)

Determine if this JavaSourceCodeImplementation contains the given set of repositoryLocations.

Parameters:

repositoryLocationsToCheck - repositoryLocations to check for.

Returns:

Collection of java.lang.Boolean. If the i^th element in repositoryLocations was found, then the i^th element of the collection will be set to true, otherwise it will be set to false. Matching is done with the isEquivalent(...) method.

hasAllRepositoryLocations

public boolean hasAllRepositoryLocations(Collection repositoryLocationsToCheck)

Determine if this JavaSourceCodeImplementation contains each element in the given set of repositoryLocations.

Parameters:

repositoryLocationsToCheck - repositoryLocations to check for.

Returns:

true if every element in repositoryLocations is found in this JavaSourceCodeImplementation, false otherwise.

setSourceCodeManager

public void setSourceCodeManager(IJavaSourceCodeManager value)

Set the sourceCodeManager for this JavaSourceCodeImplementation.

Parameters:

value - new sourceCodeManager

clearSourceCodeManager

public void clearSourceCodeManager()

Clear the sourceCodeManager from this JavaSourceCodeImplementation.

getSourceCodeManager

public IJavaSourceCodeManager getSourceCodeManager()

Get the sourceCodeManager from this JavaSourceCodeImplementation.

Returns:

sourceCodeManager

hasSourceCodeManager

public boolean hasSourceCodeManager(IJavaSourceCodeManager sourceCodeManagerToCheck)

Determine if this JavaSourceCodeImplementation has the given sourceCodeManager

Parameters:

sourceCodeManagerToCheck - sourceCodeManager to compare

Returns:

true if the sourceCodeManagers are equivalent, false otherwise

isEquivalent

public boolean isEquivalent(IJavaSourceCodeImplementation JavaSourceCodeImplementationToCheck)

Determine if another JavaSourceCodeImplementation is equivalent to this one, ignoring ID's.

Parameters:

JavaSourceCodeImplementationToCheck - JavaSourceCodeImplementation to compare to this one.

Returns:

true if all the child elements of this JavaSourceCodeImplementation are equivalent, false otherwise.