de.japkit.rules

Class RuleUtils

java.lang.Object

de.japkit.rules.RuleUtils

public class RuleUtils
extends Object

Many rules have common components, for example annotation mappings or setting modifiers. This class provides those common components as reusable closures. Each one establishes as certain naming convention for the according annotation values, for example "nameExpr" for the AV the contains an expression to determine the name of the element to be generated.

Field Summary

Fields

Modifier and Type	Field and Description
protected AnnotationExtensions	_annotationExtensions
protected ElementsExtensions	_elementsExtensions
protected ELSupport	_eLSupport
protected GenerateClassContext	_generateClassContext
protected GenExtensions	_genExtensions
protected MessageCollector	_messageCollector
protected RuleFactory	_ruleFactory
protected TypesExtensions	_typesExtensions
static org.eclipse.xtext.xbase.lib.Functions.Function0<Boolean>	ALWAYS_ACTIVE
static org.eclipse.xtext.xbase.lib.Functions.Function0<String>	NO_NAME
static org.eclipse.xtext.xbase.lib.Functions.Function0<? extends Iterable<?>>	SINGLE_SRC_ELEMENT
static org.eclipse.xtext.xbase.lib.Functions.Function1<? super Object,?>	templateAnnotationValueTransformer
protected TypesRegistry	typesRegistry
protected TypeResolver	typesResolver

Constructor Summary

Constructors

Constructor and Description
RuleUtils()

Method Summary

Modifier and Type	Method and Description
org.eclipse.xtext.xbase.lib.Functions.Function0<? extends Boolean>	createActivationRule(AnnotationMirror metaAnnotation, String avPrefix)
org.eclipse.xtext.xbase.lib.Functions.Function0<? extends Boolean>	createActivationRule(AnnotationMirror metaAnnotation, String avPrefix, org.eclipse.xtext.xbase.lib.Functions.Function0<? extends Boolean> defaultValue) AV "cond" to enable or disable a rule
org.eclipse.xtext.xbase.lib.Functions.Function1<? super GenElement,? extends List<? extends AnnotationMirror>>	createAnnotationMappingRules(AnnotationMirror metaAnnotation, Element template, String avPrefix) Copies annotations from template at first (if there are any ) and then applies the annotation mappings
org.eclipse.xtext.xbase.lib.Functions.Function0<? extends CharSequence>	createCommentRule(AnnotationMirror metaAnnotation, Element template, String avPrefix, org.eclipse.xtext.xbase.lib.Functions.Function0<? extends CharSequence> defaultComment)
ArrayList<ELVariableRule>	createELVariableRules(AnnotationMirror metaAnnotation, Element metaElement, String avPrefix)
org.eclipse.xtext.xbase.lib.Functions.Function0<?>	createExpressionOrFunctionCallAndFilterRule(AnnotationMirror metaAnnotation, Element metaElement, String exprAV, String funAV, String langAV, String filterExprAV, String filterFunAV, String collectExprAV, String collectFunAV, String toSetAV, String groupByAV, String groupByFunAV, String typeAV, String avPrefix, org.eclipse.xtext.xbase.lib.Functions.Function0<?> defaultValue, boolean nullable, String uniqueAV) Evaluates and expression and / or function(s) and optionally filters the results.
ArrayList<LibraryRule>	createLibraryRules(AnnotationMirror metaAnnotation, String avPrefix)
List<MatcherRule>	createMatcherRules(AnnotationMirror annotation, CharSequence avName) Gets a list of element matchers from an annotation.
org.eclipse.xtext.xbase.lib.Functions.Function0<? extends Set<Modifier>>	createModifiersRule(AnnotationMirror metaAnnotation, Element template, String avPrefix)
org.eclipse.xtext.xbase.lib.Functions.Function0<? extends String>	createNameExprRule(AnnotationMirror metaAnnotation, Element template, String avPrefix) To set the name of the generated element either statically (AV: name) or dynamically (AV: nameExpr)
org.eclipse.xtext.xbase.lib.Functions.Function1<? super CharSequence,? extends Boolean>	createNameInSetRule(AnnotationMirror metaAnnotation, String avName)
org.eclipse.xtext.xbase.lib.Functions.Function0<? extends List<? extends GenParameter>>	createParamRule(AnnotationMirror paramAnnotation, VariableElement template, String avPrefix)
protected org.eclipse.xtext.xbase.lib.Functions.Function0<? extends List<? extends GenParameter>>	createParamRules(AnnotationMirror paramsAnnotation, ExecutableElement template, String avPrefix)
<T> ScopeRule<T>	createScopeRule(AnnotationMirror metaAnnotation, Element metaElement, boolean isLibrary, String avPrefix)
<T> ScopeRule<T>	createScopeRule(AnnotationMirror metaAnnotation, Element metaElement, boolean isLibrary, String avPrefix, boolean createSrcRule) Rule that creates a new scope for each src element given by the source rule and executes the given closure within that scope.
<T> ScopeRule<T>	createScopeRule(AnnotationMirror metaAnnotation, Element metaElement, String avPrefix) Scope rule that gets the source element from "src" AV
<T> ScopeRule<T>	createScopeRule(AnnotationMirror metaAnnotation, Element metaElement, String avPrefix, org.eclipse.xtext.xbase.lib.Functions.Function0<?> srcRule)
org.eclipse.xtext.xbase.lib.Functions.Function0<?>	createSrcRule(AnnotationMirror metaAnnotation, String avPrefix) Provides the source element(s) for rules
org.eclipse.xtext.xbase.lib.Functions.Function0<? extends TypeMirror>	createTypeRule(AnnotationMirror metaAnnotation, TypeMirror template, String avPrefix)
org.eclipse.xtext.xbase.lib.Functions.Function0<? extends TypeMirror>	createTypeRule(AnnotationMirror metaAnnotation, TypeMirror template, String avName, String avPrefix, org.eclipse.xtext.xbase.lib.Functions.Function0<? extends TypeMirror> defaultValue)
<T> T	handleException(org.eclipse.xtext.xbase.lib.Functions.Function0<? extends T> errorResult, String avName, org.eclipse.xtext.xbase.lib.Functions.Function0<? extends T> closure)
boolean	isVariable(Element memberElement)
StringBuffer	replaceExpressionInTemplate(CharSequence template, boolean noSyntaxRestrictions, String lang, boolean autoCamelCase)
ScopeRule	scopeWithCurrentSrc()
static String	withPrefix(CharSequence name, String prefix)

Methods inherited from class java.lang.Object

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

Field Detail

_elementsExtensions

@Extension
protected final transient ElementsExtensions _elementsExtensions

_eLSupport

@Extension
protected final transient ELSupport _eLSupport

_messageCollector

@Extension
protected final transient MessageCollector _messageCollector

_annotationExtensions

@Extension
protected final transient AnnotationExtensions _annotationExtensions

_genExtensions

@Extension
protected final transient GenExtensions _genExtensions

typesResolver

@Extension
protected final transient TypeResolver typesResolver

_generateClassContext

@Extension
protected final transient GenerateClassContext _generateClassContext

_typesExtensions

@Extension
protected final transient TypesExtensions _typesExtensions

_ruleFactory

@Extension
protected final transient RuleFactory _ruleFactory

typesRegistry

@Extension
protected final transient TypesRegistry typesRegistry

SINGLE_SRC_ELEMENT

public static final org.eclipse.xtext.xbase.lib.Functions.Function0<? extends Iterable<?>> SINGLE_SRC_ELEMENT

ALWAYS_ACTIVE

public static final org.eclipse.xtext.xbase.lib.Functions.Function0<Boolean> ALWAYS_ACTIVE

NO_NAME

public static final org.eclipse.xtext.xbase.lib.Functions.Function0<String> NO_NAME

templateAnnotationValueTransformer

public static final org.eclipse.xtext.xbase.lib.Functions.Function1<? super Object,?> templateAnnotationValueTransformer

Constructor Detail

RuleUtils

public RuleUtils()

Method Detail

withPrefix

public static String withPrefix(CharSequence name,
                                String prefix)

createSrcRule

public org.eclipse.xtext.xbase.lib.Functions.Function0<?> createSrcRule(AnnotationMirror metaAnnotation,
                                                                        String avPrefix)

Provides the source element(s) for rules

createExpressionOrFunctionCallAndFilterRule

public org.eclipse.xtext.xbase.lib.Functions.Function0<?> createExpressionOrFunctionCallAndFilterRule(AnnotationMirror metaAnnotation,
                                                                                                      Element metaElement,
                                                                                                      String exprAV,
                                                                                                      String funAV,
                                                                                                      String langAV,
                                                                                                      String filterExprAV,
                                                                                                      String filterFunAV,
                                                                                                      String collectExprAV,
                                                                                                      String collectFunAV,
                                                                                                      String toSetAV,
                                                                                                      String groupByAV,
                                                                                                      String groupByFunAV,
                                                                                                      String typeAV,
                                                                                                      String avPrefix,
                                                                                                      org.eclipse.xtext.xbase.lib.Functions.Function0<?> defaultValue,
                                                                                                      boolean nullable,
                                                                                                      String uniqueAV)

Evaluates and expression and / or function(s) and optionally filters the results.

createScopeRule

public <T> ScopeRule<T> createScopeRule(AnnotationMirror metaAnnotation,
                                        Element metaElement,
                                        String avPrefix)

Scope rule that gets the source element from "src" AV

createScopeRule

public <T> ScopeRule<T> createScopeRule(AnnotationMirror metaAnnotation,
                                        Element metaElement,
                                        boolean isLibrary,
                                        String avPrefix)

createScopeRule

public <T> ScopeRule<T> createScopeRule(AnnotationMirror metaAnnotation,
                                        Element metaElement,
                                        String avPrefix,
                                        org.eclipse.xtext.xbase.lib.Functions.Function0<?> srcRule)

createScopeRule

public <T> ScopeRule<T> createScopeRule(AnnotationMirror metaAnnotation,
                                        Element metaElement,
                                        boolean isLibrary,
                                        String avPrefix,
                                        boolean createSrcRule)

Rule that creates a new scope for each src element given by the source rule and executes the given closure within that scope. Optionally puts EL-Variables into that scope.

createLibraryRules

public ArrayList<LibraryRule> createLibraryRules(AnnotationMirror metaAnnotation,
                                                 String avPrefix)

scopeWithCurrentSrc

public ScopeRule scopeWithCurrentSrc()

createELVariableRules

public ArrayList<ELVariableRule> createELVariableRules(AnnotationMirror metaAnnotation,
                                                       Element metaElement,
                                                       String avPrefix)

isVariable

public boolean isVariable(Element memberElement)

createActivationRule

public org.eclipse.xtext.xbase.lib.Functions.Function0<? extends Boolean> createActivationRule(AnnotationMirror metaAnnotation,
                                                                                               String avPrefix)

createActivationRule

public org.eclipse.xtext.xbase.lib.Functions.Function0<? extends Boolean> createActivationRule(AnnotationMirror metaAnnotation,
                                                                                               String avPrefix,
                                                                                               org.eclipse.xtext.xbase.lib.Functions.Function0<? extends Boolean> defaultValue)

AV "cond" to enable or disable a rule

replaceExpressionInTemplate

public StringBuffer replaceExpressionInTemplate(CharSequence template,
                                                boolean noSyntaxRestrictions,
                                                String lang,
                                                boolean autoCamelCase)

createNameExprRule

public org.eclipse.xtext.xbase.lib.Functions.Function0<? extends String> createNameExprRule(AnnotationMirror metaAnnotation,
                                                                                            Element template,
                                                                                            String avPrefix)

To set the name of the generated element either statically (AV: name) or dynamically (AV: nameExpr)

createAnnotationMappingRules

public org.eclipse.xtext.xbase.lib.Functions.Function1<? super GenElement,? extends List<? extends AnnotationMirror>> createAnnotationMappingRules(AnnotationMirror metaAnnotation,
                                                                                                                                                   Element template,
                                                                                                                                                   String avPrefix)

Copies annotations from template at first (if there are any ) and then applies the annotation mappings

createModifiersRule

public org.eclipse.xtext.xbase.lib.Functions.Function0<? extends Set<Modifier>> createModifiersRule(AnnotationMirror metaAnnotation,
                                                                                                    Element template,
                                                                                                    String avPrefix)

createTypeRule

public org.eclipse.xtext.xbase.lib.Functions.Function0<? extends TypeMirror> createTypeRule(AnnotationMirror metaAnnotation,
                                                                                            TypeMirror template,
                                                                                            String avPrefix)

createTypeRule

public org.eclipse.xtext.xbase.lib.Functions.Function0<? extends TypeMirror> createTypeRule(AnnotationMirror metaAnnotation,
                                                                                            TypeMirror template,
                                                                                            String avName,
                                                                                            String avPrefix,
                                                                                            org.eclipse.xtext.xbase.lib.Functions.Function0<? extends TypeMirror> defaultValue)

createParamRules

protected org.eclipse.xtext.xbase.lib.Functions.Function0<? extends List<? extends GenParameter>> createParamRules(AnnotationMirror paramsAnnotation,
                                                                                                                   ExecutableElement template,
                                                                                                                   String avPrefix)

createParamRule

public org.eclipse.xtext.xbase.lib.Functions.Function0<? extends List<? extends GenParameter>> createParamRule(AnnotationMirror paramAnnotation,
                                                                                                               VariableElement template,
                                                                                                               String avPrefix)

createCommentRule

public org.eclipse.xtext.xbase.lib.Functions.Function0<? extends CharSequence> createCommentRule(AnnotationMirror metaAnnotation,
                                                                                                 Element template,
                                                                                                 String avPrefix,
                                                                                                 org.eclipse.xtext.xbase.lib.Functions.Function0<? extends CharSequence> defaultComment)

createNameInSetRule

public org.eclipse.xtext.xbase.lib.Functions.Function1<? super CharSequence,? extends Boolean> createNameInSetRule(AnnotationMirror metaAnnotation,
                                                                                                                   String avName)

createMatcherRules

public List<MatcherRule> createMatcherRules(AnnotationMirror annotation,
                                            CharSequence avName)

Gets a list of element matchers from an annotation.

handleException

public <T> T handleException(org.eclipse.xtext.xbase.lib.Functions.Function0<? extends T> errorResult,
                             String avName,
                             org.eclipse.xtext.xbase.lib.Functions.Function0<? extends T> closure)