|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.emf.validation.service.AbstractConstraintDescriptor
public abstract class AbstractConstraintDescriptor
A partial implementation of the IConstraintDescriptor interface
that is useful for subclassing.
This class may be extended by constraint providers.
| Constructor Summary | |
|---|---|
protected |
AbstractConstraintDescriptor()
Default initialization. |
| Method Summary | |
|---|---|
void |
addCategory(Category category)
Adds a category to me. |
boolean |
equals(Object other)
Equality is defined by equality of IDs. |
Set |
getCategories()
Queries the categories that I am a member of. |
IConstraintDescriptor |
getDescriptor()
|
Throwable |
getException()
If I am an error constraint, obtains the exception
that caused me not to be initialized. |
int |
hashCode()
|
boolean |
isBatch()
Queries whether I may be applied in "batch" mode, i.e., outside of any particular editing action context. |
boolean |
isEnabled()
Queries whether the constraint is enabled. |
boolean |
isError()
Queries whether the constraint is errored, i.e., not executable because of some error in initializing it. |
boolean |
isLive()
Queries whether I may be applied in "live" mode, i.e., within some particular editing action context. |
void |
removeCategory(Category category)
Removes a category from me. |
void |
setEnabled(boolean enabled)
Sets whether the constraint is enabled. |
void |
setError(Throwable exception)
Sets my error status. |
String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.eclipse.emf.validation.service.IConstraintDescriptor |
|---|
getBody, getDescription, getEvaluationMode, getId, getMessagePattern, getName, getPluginId, getSeverity, getStatusCode, targetsEvent, targetsTypeOf |
| Constructor Detail |
|---|
protected AbstractConstraintDescriptor()
| Method Detail |
|---|
public final boolean isError()
IConstraintDescriptor
isError in interface IConstraintDescriptorpublic final Throwable getException()
IConstraintDescriptorerror constraint, obtains the exception
that caused me not to be initialized.
getException in interface IConstraintDescriptorpublic final void setError(Throwable exception)
IConstraintDescriptorSets my error status.
This method should not be called outside of the validation framework.
setError in interface IConstraintDescriptorexception - the exception that causes me to be an error constraintpublic final boolean isEnabled()
IConstraintDescriptorErrored
constraints are never enabled; other constraints may be disabled
by the user.
isEnabled in interface IConstraintDescriptorpublic final void setEnabled(boolean enabled)
IConstraintDescriptorerrored and are
not in a mandatory category.
setEnabled in interface IConstraintDescriptorenabled - whether the constraint that I represent is enabledIConstraintDescriptor.isEnabled()public Set getCategories()
IConstraintDescriptor
getCategories in interface IConstraintDescriptorCategoryspublic void addCategory(Category category)
IConstraintDescriptor
addCategory in interface IConstraintDescriptorcategory - my categorypublic void removeCategory(Category category)
IConstraintDescriptor
removeCategory in interface IConstraintDescriptorcategory - a categorypublic boolean isBatch()
IConstraintDescriptor
isBatch in interface IConstraintDescriptortrue if I support "batch" (contextless)
invocation; false, otherwiseIConstraintDescriptor.getEvaluationMode()public boolean isLive()
IConstraintDescriptor
isLive in interface IConstraintDescriptortrue if I support "live" (contextful) invocation;
false, otherwiseIConstraintDescriptor.getEvaluationMode()public final IConstraintDescriptor getDescriptor()
public int hashCode()
hashCode in class Objectpublic boolean equals(Object other)
IDs.
equals in class ObjectIConstraintDescriptor.getId()public String toString()
toString in class Object
|
Copyright 2002, 2007 IBM Corporation and others. All Rights Reserved. |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||