edu.uci.isr.xarch.javasourcecode
Interface IJavaSourceFile

All Superinterfaces:

IXArchElement

All Known Implementing Classes:

JavaSourceFileImpl

public interface IJavaSourceFile

extends IXArchElement

Interface for accessing objects of the JavaSourceFile xsi:type in the javasourcecode namespace.

Author:

Automatically generated by 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 JavaSourceFile.
void	addRepositoryLocations(Collection repositoryLocations) Add a collection of repositoryLocations to this JavaSourceFile.
void	clearFileName() Remove the fileName attribute from this JavaSourceFile.
void	clearPath() Remove the path attribute from this JavaSourceFile.
void	clearRepositoryLocations() Remove all repositoryLocations from this JavaSourceFile.
Collection	getAllRepositoryLocations() Get all the repositoryLocations from this JavaSourceFile.
String	getFileName() Get the fileName attribute from this JavaSourceFile.
String	getPath() Get the path attribute from this JavaSourceFile.
boolean	hasAllRepositoryLocations(Collection repositoryLocationsToCheck) Determine if this JavaSourceFile contains each element in the given set of repositoryLocations.
boolean	hasFileName(String fileName) Determine if the fileName attribute on this JavaSourceFile has the given value.
boolean	hasPath(String path) Determine if the path attribute on this JavaSourceFile has the given value.
boolean	hasRepositoryLocation(IRepositoryLocation repositoryLocationToCheck) Determine if this JavaSourceFile contains a given repositoryLocation.
Collection	hasRepositoryLocations(Collection repositoryLocationsToCheck) Determine if this JavaSourceFile contains the given set of repositoryLocations.
boolean	isEquivalent(IJavaSourceFile JavaSourceFileToCheck) Determine if another JavaSourceFile is equivalent to this one, ignoring ID's.
void	removeRepositoryLocation(IRepositoryLocation repositoryLocationToRemove) Remove the given repositoryLocation from this JavaSourceFile.
void	removeRepositoryLocations(Collection repositoryLocations) Remove all the given repositoryLocations from this JavaSourceFile.
void	setFileName(String fileName) Set the fileName attribute on this JavaSourceFile.
void	setPath(String path) Set the path attribute on this JavaSourceFile.

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

setFileName

public void setFileName(String fileName)

Set the fileName attribute on this JavaSourceFile.

Parameters:

fileName - fileName

Throws:

FixedValueException - if the attribute has a fixed value and the value passed is not the fixed value.

clearFileName

public void clearFileName()

Remove the fileName attribute from this JavaSourceFile.

getFileName

public String getFileName()

Get the fileName attribute from this JavaSourceFile. if the attribute has a fixed value, this function will return that fixed value, even if it is not actually present in the XML document.

Returns:

fileName on this JavaSourceFile

hasFileName

public boolean hasFileName(String fileName)

Determine if the fileName attribute on this JavaSourceFile has the given value.

Parameters:

fileName - Attribute value to compare

Returns:

true if they match; false otherwise.

setPath

public void setPath(String path)

Set the path attribute on this JavaSourceFile.

Parameters:

path - path

Throws:

FixedValueException - if the attribute has a fixed value and the value passed is not the fixed value.

clearPath

public void clearPath()

Remove the path attribute from this JavaSourceFile.

getPath

public String getPath()

Get the path attribute from this JavaSourceFile. if the attribute has a fixed value, this function will return that fixed value, even if it is not actually present in the XML document.

Returns:

path on this JavaSourceFile

hasPath

public boolean hasPath(String path)

Determine if the path attribute on this JavaSourceFile has the given value.

Parameters:

path - Attribute value to compare

Returns:

true if they match; false otherwise.

addRepositoryLocation

public void addRepositoryLocation(IRepositoryLocation newRepositoryLocation)

Add a repositoryLocation to this JavaSourceFile.

Parameters:

newRepositoryLocation - repositoryLocation to add.

addRepositoryLocations

public void addRepositoryLocations(Collection repositoryLocations)

Add a collection of repositoryLocations to this JavaSourceFile.

Parameters:

repositoryLocations - repositoryLocations to add.

clearRepositoryLocations

public void clearRepositoryLocations()

Remove all repositoryLocations from this JavaSourceFile.

removeRepositoryLocation

public void removeRepositoryLocation(IRepositoryLocation repositoryLocationToRemove)

Remove the given repositoryLocation from this JavaSourceFile. 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 JavaSourceFile. Matching is done by the isEquivalent(...) function.

Parameters:

repositoryLocations - repositoryLocation to remove.

getAllRepositoryLocations

public Collection getAllRepositoryLocations()

Get all the repositoryLocations from this JavaSourceFile.

Returns:

all repositoryLocations in this JavaSourceFile.

hasRepositoryLocation

public boolean hasRepositoryLocation(IRepositoryLocation repositoryLocationToCheck)

Determine if this JavaSourceFile contains a given repositoryLocation.

Returns:

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

hasRepositoryLocations

public Collection hasRepositoryLocations(Collection repositoryLocationsToCheck)

Determine if this JavaSourceFile 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 JavaSourceFile 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 JavaSourceFile, false otherwise.

isEquivalent

public boolean isEquivalent(IJavaSourceFile JavaSourceFileToCheck)

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

Parameters:

JavaSourceFileToCheck - JavaSourceFile to compare to this one.

Returns:

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