org.apache.polygene.api.constraint

Class ConstraintViolationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalArgumentException

org.apache.polygene.api.constraint.ConstraintViolationException

All Implemented Interfaces:

Serializable

public class ConstraintViolationException
extends IllegalArgumentException

This Exception is thrown when there is one or more Constraint Violations in a method call.

The Constraint Violations are aggregated per method, and this exception will contain those violations, together with the Composite instance it happened on as well as the Method that was invoked. The Exception also has support for localized messages of these violations.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConstraintViolationException(Collection<ValueConstraintViolation> violations)

Method Summary

Modifier and Type	Method and Description
Collection<ValueConstraintViolation>	constraintViolations()
String	getMessage()
String	localizedMessageFrom(ResourceBundle bundle) Creates localized message of all the constraint violations that has occured.
void	setCompositeDescriptor(CompositeDescriptor descriptor)
void	setIdentity(Identity identity)
void	setInstanceString(String instanceString)

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConstraintViolationException

public ConstraintViolationException(Collection<ValueConstraintViolation> violations)

Method Detail

constraintViolations

public Collection<ValueConstraintViolation> constraintViolations()

localizedMessageFrom

public String localizedMessageFrom(ResourceBundle bundle)

Creates localized message of all the constraint violations that has occured.

Each ConstraintViolationException concerns one Composite instance, but may have many violations on that instance. For the composite instance related message following entries in the ResourceBundle will be searched for a pattern in the following order;

1. polygene.constraint.CompositeType
2. polygene.constraint.composite

where CompositeType is the class name of the Composite instance. If such key does not exist, or if the resourceBundle argument is null, then the default patterns will be used;

Type of Composite	Pattern used
Composite	\tConstraint Violation(s) in {0} with types {3}\n
EntityComposite	Constraint Violation in {2}.{3} with constraint {4}, in entity {1}[id={0}]
ServiceComposite	Constraint Violation in {2}.{3} with constraint {4}, in service {0}

The ResourceBundle arguments are defined as;

Then format each ConstraintViolation according to such pattern, where the following argument are passed;

Arg	Value
{0}	Primary Type of Composite
{1}	Composite instance toString()
{2}	Identity if composite implements HasIdentity
{3}	Comma-separeated list of types implemented by Composite

Once the message at the composite type level has been established, the message will contain each of the found violations. For each such violation, the resource bundle will be searched in the following order;

1. polygene.constraint.MixinType.member
2. polygene.constraint.MixinType
3. polygene.constraint.mixin

where MixinType refers to the mixin type of the member (method, field or constructor) and the member is the name of such Member.

Type of Composite	Pattern used
Mixin	\t\t@{2} {0}.{1} does not allow value [{4}]

For these the ResourceBundle arguments are;

Arg	Value
{0}	Mixin Type Name
{1}	Mixin Member Name
{2}	Annotation type
{3}	Annotation toString
{4}	Name of the Member, see Name
{5}	Value attempted

Parameters:

bundle - The ResourceBundle for Localization, or null if default formatting and locale to be used.

Returns:

An array of localized messages of the violations incurred.

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

setCompositeDescriptor

public void setCompositeDescriptor(CompositeDescriptor descriptor)

setIdentity

public void setIdentity(Identity identity)

setInstanceString

public void setInstanceString(String instanceString)