org.apache.tools.ant.taskdefs.optional

Class SchemaValidate.SchemaLocation

public static class SchemaValidate.SchemaLocation extends Object

representation of a schema location. This is a URI plus either a file or a url
Field Summary
static StringERROR_NO_FILE
File not found
static StringERROR_NO_LOCATION
No location provided
static StringERROR_NO_URI
No namespace URI
static StringERROR_NO_URL_REPRESENTATION
Cannot make URL
static StringERROR_TWO_LOCATIONS
Both URL and File were given for schema
Constructor Summary
SchemaLocation()
No arg constructor
Method Summary
booleanequals(Object o)
equality test checks namespace, location and filename.
FilegetFile()
Get the file.
StringgetNamespace()
Get the namespace.
StringgetSchemaLocationURL()
get the URL of the schema
StringgetUrl()
The URL containing the schema.
StringgetURIandLocation()
validate the fields then create a "uri location" string
inthashCode()
Generate a hashcode depending on the namespace, url and file name.
voidsetFile(File file)
identify a file that contains this namespace's schema.
voidsetNamespace(String namespace)
set the namespace of this schema.
voidsetUrl(String url)
identify a URL that hosts the schema.
StringtoString()
Returns a string representation of the object for error messages and the like
voidvalidateNamespace()
assert that a namespace is valid

Field Detail

ERROR_NO_FILE

public static final String ERROR_NO_FILE
File not found

ERROR_NO_LOCATION

public static final String ERROR_NO_LOCATION
No location provided

ERROR_NO_URI

public static final String ERROR_NO_URI
No namespace URI

ERROR_NO_URL_REPRESENTATION

public static final String ERROR_NO_URL_REPRESENTATION
Cannot make URL

ERROR_TWO_LOCATIONS

public static final String ERROR_TWO_LOCATIONS
Both URL and File were given for schema

Constructor Detail

SchemaLocation

public SchemaLocation()
No arg constructor

Method Detail

equals

public boolean equals(Object o)
equality test checks namespace, location and filename. All must match,

Parameters: o object to compare against

Returns: true iff the objects are considered equal in value

getFile

public File getFile()
Get the file.

Returns: the file containing the schema.

getNamespace

public String getNamespace()
Get the namespace.

Returns: the namespace.

getSchemaLocationURL

public String getSchemaLocationURL()
get the URL of the schema

Returns: a URL to the schema

Throws: BuildException if not

getUrl

public String getUrl()
The URL containing the schema.

Returns: the URL string.

getURIandLocation

public String getURIandLocation()
validate the fields then create a "uri location" string

Returns: string of uri and location

Throws: BuildException if there is an error.

hashCode

public int hashCode()
Generate a hashcode depending on the namespace, url and file name.

Returns: the hashcode.

setFile

public void setFile(File file)
identify a file that contains this namespace's schema. The file must exist.

Parameters: file the file contains the schema.

setNamespace

public void setNamespace(String namespace)
set the namespace of this schema. Any URI

Parameters: namespace the namespace to use.

setUrl

public void setUrl(String url)
identify a URL that hosts the schema.

Parameters: url the URL string.

toString

public String toString()
Returns a string representation of the object for error messages and the like

Returns: a string representation of the object.

validateNamespace

public void validateNamespace()
assert that a namespace is valid

Throws: BuildException if not