org.apache.tools.ant.taskdefs.optional

Class SchemaValidate.SchemaLocation

Enclosing Class:
SchemaValidate

public static class SchemaValidate.SchemaLocation
extends java.lang.Object

representation of a schema location. This is a URI plus either a file or a url

Field Summary

static String
ERROR_NO_FILE
File not found
static String
ERROR_NO_LOCATION
No location provided
static String
ERROR_NO_URI
No namespace URI
static String
ERROR_NO_URL_REPRESENTATION
Cannot make URL
static String
ERROR_TWO_LOCATIONS
Both URL and File were given for schema

Constructor Summary

SchemaLocation()
No arg constructor

Method Summary

boolean
equals(Object o)
equality test checks namespace, location and filename.
File
getFile()
Get the file.
String
getNamespace()
Get the namespace.
String
getSchemaLocationURL()
get the URL of the schema
String
getURIandLocation()
validate the fields then create a "uri location" string
String
getUrl()
The URL containing the schema.
int
hashCode()
Generate a hashcode depending on the namespace, url and file name.
void
setFile(File file)
identify a file that contains this namespace's schema.
void
setNamespace(String namespace)
set the namespace of this schema.
void
setUrl(String url)
identify a URL that hosts the schema.
String
toString()
Returns a string representation of the object for error messages and the like
void
validateNamespace()
assert that a namespace is valid

Field Details

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 Details

SchemaLocation

public SchemaLocation()
No arg constructor

Method Details

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

getURIandLocation

public String getURIandLocation()
            throws BuildException
validate the fields then create a "uri location" string
Returns:
string of uri and location
Throws:
BuildException - if there is an error.

getUrl

public String getUrl()
The URL containing the schema.
Returns:
the URL string.

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