org.eclipse.emf.ecore.util

Class EcoreAnnotationValidator

java.lang.Object

org.eclipse.emf.ecore.util.BasicEAnnotationValidator

org.eclipse.emf.ecore.util.EcoreAnnotationValidator

All Implemented Interfaces:

EAnnotationValidator

public final class EcoreAnnotationValidator
extends BasicEAnnotationValidator

An annotation validator for Ecore annotations.

Since:

2.14

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.emf.ecore.util.BasicEAnnotationValidator

BasicEAnnotationValidator.Assistant, BasicEAnnotationValidator.ValidationContext

Nested classes/interfaces inherited from interface org.eclipse.emf.ecore.EAnnotationValidator

EAnnotationValidator.Descriptor, EAnnotationValidator.Registry

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DIAGNOSTIC_SOURCE
static EcoreAnnotationValidator	INSTANCE

Fields inherited from class org.eclipse.emf.ecore.util.BasicEAnnotationValidator

annotationName, annotationSource, assistant, diagnosticSource, IGNORED_ANNOTATIONS, IGNORED_CONTENTS, IGNORED_ENTRY, IGNORED_REFERENCES, INVALID_ANNOTATION, INVALID_CONTENT, INVALID_DETAIL_VALUE, INVALID_DUPLICATE, INVALID_LOCATION, INVALID_REFERENCE, INVALID_REFERENCE_LITERAL, INVALID_VALUE_LITERAL, MISSING_ENTRY, MISSING_REQUIRED_ENTRY_VALUE, TOO_FEW_VALUES, TOO_MANY_VALUES

Constructor Summary

Constructors

Constructor and Description
EcoreAnnotationValidator()

Method Summary

Modifier and Type	Method and Description
protected java.util.List<EClass>	getPropertyClasses(EModelElement eModelElement) Returns the model classes used to represent annotations for the given model element.
protected ResourceLocator	getResourceLocator() Returns the resource locator for fetching implementation-specific messages.
protected boolean	isValidLocation(EAnnotation eAnnotation, EModelElement eModelElement) Returns whether this annotation contained by this model element is valid at this location.
protected boolean	validateAttributeDetailValueLiteral(EAnnotation eAnnotation, EModelElement eModelElement, java.util.Map.Entry<java.lang.String,java.lang.String> entry, EAttribute attribute, java.lang.String literalValue, java.util.List<java.lang.Object> dataValues, DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) Returns whether the given literal value is valid with respect to this detail entry's corresponding attribute's data type.

Methods inherited from class org.eclipse.emf.ecore.util.BasicEAnnotationValidator

convertPropertyAttributeValueToLiteralItem, convertPropertyReferenceValueToLiteralItem, convertPropertyValueToLiteral, convertPropertyValueToLiteralItem, createAssistant, createDiagnostic, createInstance, createValueDiagnostic, getAllValidAnnotations, getAnnotationSource, getAssistant, getEcoreResourceLocator, getProperties, getRootEValidator, getString, getValidAnnotations, getValidContents, getValidLocationDescription, getValidReferences, initialize, isAnnotationsSupported, isApplicable, isContentsSupported, isDuplicateValid, isIncludedProperty, isReferencesSupported, isValidLocation, join, loadEPackage, reportDuplicate, reportIgnoredAnnotations, reportIgnoredContents, reportIgnoredEntry, reportIgnoredReferences, reportInvalidAnnotation, reportInvalidContent, reportInvalidLocation, reportInvalidReference, reportInvalidReferenceLiteral, reportInvalidValueLiteral, reportMissingEntry, reportMissingRequiredEntryValue, reportTooFewValues, reportTooManyValues, split, validate, validateAnnotations, validateAttributeDetailLiteralValue, validateContents, validateDetail, validateDetails, validateFeatureDetail, validateFeatureDetailValue, validateReferenceDetailLiteralValue, validateReferenceDetailValueLiteral, validateReferences

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final EcoreAnnotationValidator INSTANCE

DIAGNOSTIC_SOURCE

public static final java.lang.String DIAGNOSTIC_SOURCE

See Also:

Constant Field Values

Constructor Detail

EcoreAnnotationValidator

public EcoreAnnotationValidator()

Method Detail

getResourceLocator

protected ResourceLocator getResourceLocator()

Description copied from class: BasicEAnnotationValidator

Returns the resource locator for fetching implementation-specific messages.

Specified by:

getResourceLocator in class BasicEAnnotationValidator

Returns:

the resource locator for fetching model-specific messages.

isValidLocation

protected boolean isValidLocation(EAnnotation eAnnotation,
                                  EModelElement eModelElement)

Description copied from class: BasicEAnnotationValidator

Returns whether this annotation contained by this model element is valid at this location.

This implementation returns false if the element is not a named element. It's typically the case that annotations on annotations aren't meaningful and valid.

Overrides:

isValidLocation in class BasicEAnnotationValidator

Parameters:

eAnnotation - the annotation in question.

eModelElement - the annotation's containing model element.

Returns:

whether this annotation contained by this model element is valid at this location.

See Also:

BasicEAnnotationValidator.isValidLocation(EAnnotation), BasicEAnnotationValidator.validate(EAnnotation, DiagnosticChain, Map)

getPropertyClasses

protected java.util.List<EClass> getPropertyClasses(EModelElement eModelElement)

Description copied from class: BasicEAnnotationValidator

Returns the model classes used to represent annotations for the given model element.

Typically an annotation validator implementation will return a single class. An induced user interface will generally require the ability to create instances of the classes returned by this method. The annotation validator implementation itself does not require that ability.

Specified by:

getPropertyClasses in class BasicEAnnotationValidator

Parameters:

eModelElement - the model element in question.

Returns:

the model classes used to represent annotations for the given model element.

validateAttributeDetailValueLiteral

protected boolean validateAttributeDetailValueLiteral(EAnnotation eAnnotation,
                                                      EModelElement eModelElement,
                                                      java.util.Map.Entry<java.lang.String,java.lang.String> entry,
                                                      EAttribute attribute,
                                                      java.lang.String literalValue,
                                                      java.util.List<java.lang.Object> dataValues,
                                                      DiagnosticChain diagnostics,
                                                      java.util.Map<java.lang.Object,java.lang.Object> context)

Description copied from class: BasicEAnnotationValidator

Returns whether the given literal value is valid with respect to this detail entry's corresponding attribute's data type. As a side-effect, if the literal value can be converted to an instance value, the corresponding instance value is added to the list of data values.

This implementation first tries to convert the literal value to an instance value of the data type. If that fails, it creates a diagnostic that includes the exception message. Otherwise, it adds the instance value to the list of values and validates the instance value.

Overrides:

validateAttributeDetailValueLiteral in class BasicEAnnotationValidator

Parameters:

eAnnotation - the annotation in question.

eModelElement - the annotation's containing model element.

entry - the annotation detail in question.

attribute - feature the attribute property associated with entry.

literalValue - the literal value of the data type.

dataValues - the list in which to accumulate a valid instance value.

diagnostics - a place to accumulate diagnostics; if it's null, no diagnostics should be produced.

context - a place to cache information, if it's null, no cache is supported.

Returns:

whether the given literal value is valid with respect to this detail entry's corresponding attribute's data type.