edu.uci.isr.xarch.javasourcecode
Interface IRepositoryLocation

All Superinterfaces:

IXArchElement

All Known Implementing Classes:

RepositoryLocationImpl

public interface IRepositoryLocation

extends IXArchElement

Interface for accessing objects of the RepositoryLocation 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	clearFileName() Remove the fileName attribute from this RepositoryLocation.
void	clearPath() Remove the path attribute from this RepositoryLocation.
void	clearUrl() Clear the url from this RepositoryLocation.
String	getFileName() Get the fileName attribute from this RepositoryLocation.
String	getPath() Get the path attribute from this RepositoryLocation.
IXMLLink	getUrl() Get the url from this RepositoryLocation.
boolean	hasFileName(String fileName) Determine if the fileName attribute on this RepositoryLocation has the given value.
boolean	hasPath(String path) Determine if the path attribute on this RepositoryLocation has the given value.
boolean	hasUrl(IXMLLink urlToCheck) Determine if this RepositoryLocation has the given url
boolean	isEquivalent(IRepositoryLocation RepositoryLocationToCheck) Determine if another RepositoryLocation is equivalent to this one, ignoring ID's.
void	setFileName(String fileName) Set the fileName attribute on this RepositoryLocation.
void	setPath(String path) Set the path attribute on this RepositoryLocation.
void	setUrl(IXMLLink value) Set the url for this RepositoryLocation.

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 RepositoryLocation.

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 RepositoryLocation.

getFileName

public String getFileName()

Get the fileName attribute from this RepositoryLocation. 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 RepositoryLocation

hasFileName

public boolean hasFileName(String fileName)

Determine if the fileName attribute on this RepositoryLocation 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 RepositoryLocation.

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 RepositoryLocation.

getPath

public String getPath()

Get the path attribute from this RepositoryLocation. 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 RepositoryLocation

hasPath

public boolean hasPath(String path)

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

Parameters:

path - Attribute value to compare

Returns:

true if they match; false otherwise.

setUrl

public void setUrl(IXMLLink value)

Set the url for this RepositoryLocation.

Parameters:

value - new url

clearUrl

public void clearUrl()

Clear the url from this RepositoryLocation.

getUrl

public IXMLLink getUrl()

Get the url from this RepositoryLocation.

Returns:

url

hasUrl

public boolean hasUrl(IXMLLink urlToCheck)

Determine if this RepositoryLocation has the given url

Parameters:

urlToCheck - url to compare

Returns:

true if the urls are equivalent, false otherwise

isEquivalent

public boolean isEquivalent(IRepositoryLocation RepositoryLocationToCheck)

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

Parameters:

RepositoryLocationToCheck - RepositoryLocation to compare to this one.

Returns:

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