org.apache.jena.iri

Class Violation

java.lang.Object

org.apache.jena.iri.Violation

All Implemented Interfaces:

IRIComponents, ViolationCodes

Direct Known Subclasses:

ViolationImpl

public abstract class Violation
extends Object
implements ViolationCodes, IRIComponents

Information concerning a violation of some specification concerning IRIs. This may be wrapped in an IRIException and thrown, or may be returned by IRI.violations(boolean). Which conditions result in errors and warnings depends on the setting of the related IRIFactory.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jena.iri.ViolationCodes

ViolationCodes.Initialize

Field Summary

Fields inherited from interface org.apache.jena.iri.ViolationCodes

ACE_PREFIX, BAD_BIDI_SUBCOMPONENT, BAD_DOT_IN_IDN, BAD_IDN, BAD_IDN_UNASSIGNED_CHARS, BIDI_FORMATTING_CHARACTER, COMPATIBILITY_CHARACTER, CONTROL_CHARACTER, DEFAULT_PORT_SHOULD_BE_OMITTED, DEPRECATED_UNICODE_CHARACTER, DISCOURAGED_IRI_CHARACTER, DISCOURAGED_XML_CHARACTER, DNS_LABEL_DASH_START_OR_END, DNS_LABEL_LENGTH_LIMIT, DNS_LENGTH_LIMIT, DOUBLE_DASH_IN_REG_NAME, DOUBLE_WHITESPACE, EMPTY_SCHEME, HAS_PASSWORD, ILLEGAL_CHARACTER, ILLEGAL_PERCENT_ENCODING, IP_V4_OCTET_RANGE, IP_V6_OR_FUTURE_ADDRESS_SYNTAX, IPv6ADDRESS_SHOULD_BE_LOWERCASE, LONE_SURROGATE, LOWERCASE_PREFERRED, MAYBE_NOT_NFC, MAYBE_NOT_NFKC, NON_INITIAL_DOT_SEGMENT, NON_URI_CHARACTER, NON_XML_CHARACTER, NOT_DNS_NAME, NOT_NFC, NOT_NFKC, NOT_UTF8_ESCAPE, NOT_UTF8_ESCAPE_IN_HOST, NOT_XML_SCHEMA_WHITESPACE, PERCENT, PERCENT_20, PERCENT_ENCODING_SHOULD_BE_UPPERCASE, PORT_SHOULD_NOT_BE_EMPTY, PORT_SHOULD_NOT_BE_WELL_KNOWN, PORT_SHOULD_NOT_START_IN_ZERO, PRIVATE_USE_CHARACTER, PROHIBITED_COMPONENT_PRESENT, QUERY_IN_LEGACY_SCHEME, REQUIRED_COMPONENT_MISSING, SCHEME_INCLUDES_DASH, SCHEME_MUST_START_WITH_LETTER, SCHEME_PATTERN_MATCH_FAILED, SCHEME_PREFERS_LOWERCASE, SCHEME_REQUIRES_LOWERCASE, SUPERFLUOUS_ASCII_PERCENT_ENCODING, SUPERFLUOUS_NON_ASCII_PERCENT_ENCODING, UNASSIGNED_UNICODE_CHARACTER, UNDEFINED_UNICODE_CHARACTER, UNICODE_CONTROL_CHARACTER, UNICODE_WHITESPACE, UNREGISTERED_IANA_SCHEME, UNREGISTERED_NONIETF_SCHEME_TREE, UNWISE_CHARACTER, USE_PUNYCODE_NOT_PERCENTS, WHITESPACE

Fields inherited from interface org.apache.jena.iri.IRIComponents

AUTHORITY, FRAGMENT, HOST, PATH, PATHQUERY, PORT, QUERY, SCHEME, USER

Constructor Summary

Constructors

Constructor and Description
Violation()

Method Summary

Modifier and Type	Method and Description
abstract String	codeName() A string version of the code number, corresponding to the name of the java identifier.
abstract String	component() The name of the component in which the problem occurred.
abstract int	getComponent() A value from IRIComponents indicating which component of the IRI is involved with this error.
abstract IRI	getIRI() The IRI that triggered this condition.
abstract String	getLongMessage() A long description of the error condition, typically including the
abstract String	getShortMessage() A short description of the error condition.
abstract String	getSpecificationURL() The URL of the section of the specification which has been violated.
abstract int	getViolationCode() The value from ViolationCodes corresponding to this condition.
abstract boolean	isError() Using the settings of the factory associated with the IRI associated with this violation, is this condition intended as an error (or as a warning)?

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Violation

public Violation()

Method Detail

getViolationCode

public abstract int getViolationCode()

The value from ViolationCodes corresponding to this condition.

Returns:

An error code.

getIRI

public abstract IRI getIRI()

The IRI that triggered this condition. If an IRI has been constructed by resolving a relative reference against a base IRI then exceptions associated with that IRI will have the most informative value here, which can be any of the three IRIs involved (the base IRI, the relative IRI or the resolved IRI).

Returns:

The IRI that triggered the error.

getComponent

public abstract int getComponent()

A value from IRIComponents indicating which component of the IRI is involved with this error.

Returns:

A code indicating the IRI component in which the error occurred.

codeName

public abstract String codeName()

A string version of the code number, corresponding to the name of the java identifier.

Returns:

The name of the java identifier of the error code for this error.

getShortMessage

public abstract String getShortMessage()

A short description of the error condition. (Short is in comparison with getLongMessage(), not an absolute value).

Returns:

The error message.

getLongMessage

public abstract String getLongMessage()

A long description of the error condition, typically including the

Returns:

The error message.

getSpecificationURL

public abstract String getSpecificationURL()

The URL of the section of the specification which has been violated.

Returns:

The error message.

isError

public abstract boolean isError()

Using the settings of the factory associated with the IRI associated with this violation, is this condition intended as an error (or as a warning)?

Returns:

true if this condition is an error, false if it is a warning.

component

public abstract String component()

The name of the component in which the problem occurred.

Returns:

A component name.