com.vaadin.generator.registry

Class ExclusionRegistry

java.lang.Object

com.vaadin.generator.registry.ExclusionRegistry

public class ExclusionRegistry
extends Object

Registry for all exclusions in the generated files. Excluded properties, events or methods are not generated.

Since:

1.0

Author:

Vaadin Ltd

Method Summary

Modifier and Type	Method and Description
static void	excludeBehaviorOrMixin(String elementTag, String behaviorName) Excludes a behavior or mixin from being evaluated for a specific element denoted by its tag.
static void	excludeEvent(String elementTag, String eventName) Excludes an event from being generated for a specific element denoted by its tag.
static void	excludeInterface(String elementTag, Class<?> interfaceClass) Excludes an interface from being evaluated for a specific element denoted by its tag.
static void	excludeMethod(String elementTag, String methodName) Excludes a method from being generated for a specific element denoted by its tag.
static void	excludeProperty(String elementTag, String propertyName) Excludes a property from being generated for a specific element denoted by its tag.
static void	excludePropertyType(ComponentBasicType type) Excludes all the properties that have the given type from all the components.
static void	excludeTag(String elementTag) Excludes the element generation denoted by its tag.
static boolean	isBehaviorOrMixinExcluded(String elementTag, String behaviorName) Gets whether a behavior or mixin should be excluded or not from the generation.
static boolean	isEventExcluded(String elementTag, String eventName) Gets whether an event should be excluded or not from the generation.
static boolean	isInterfaceExcluded(String elementTag, Class<?> interfaceClass) Gets whether an interface should be excluded or not from the generation.
static boolean	isMethodExcluded(String elementTag, String methodName) Gets whether a method should be excluded or not from the generation.
static boolean	isPropertyExcluded(String elementTag, String propertyName, Set<ComponentBasicType> type) Gets whether a property should be excluded or not from the generation.
static boolean	isTagExcluded(String elementTag) Gets whether an Element should be excluded or not from the generation.

Methods inherited from class java.lang.Object

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

Method Detail

excludeTag

public static void excludeTag(String elementTag)

Excludes the element generation denoted by its tag.

Parameters:

elementTag - the tag of the element, which is going to be skipped generation.

excludePropertyType

public static void excludePropertyType(ComponentBasicType type)

Excludes all the properties that have the given type from all the components.

Parameters:

type - the property type to exclude

isTagExcluded

public static boolean isTagExcluded(String elementTag)

Gets whether an Element should be excluded or not from the generation.

Parameters:

elementTag - the tag of the element

Returns:

true if the element should be excluded, false otherwise

excludeProperty

public static void excludeProperty(String elementTag,
                                   String propertyName)

Excludes a property from being generated for a specific element denoted by its tag.

Parameters:

elementTag - the tag of the element which the property should be excluded from generation. Setting null makes the exclusion apply to all elements

propertyName - the name of the property to be excluded

excludeEvent

public static void excludeEvent(String elementTag,
                                String eventName)

Excludes an event from being generated for a specific element denoted by its tag.

Parameters:

elementTag - the tag of the element which the event should be excluded from generation. Setting null makes the exclusion apply to all elements

eventName - the name of the event to be excluded

excludeMethod

public static void excludeMethod(String elementTag,
                                 String methodName)

Excludes a method from being generated for a specific element denoted by its tag.

Parameters:

elementTag - the tag of the element which the method should be excluded from generation. Setting null makes the exclusion apply to all elements

methodName - the name of the method to be excluded

excludeBehaviorOrMixin

public static void excludeBehaviorOrMixin(String elementTag,
                                          String behaviorName)

Excludes a behavior or mixin from being evaluated for a specific element denoted by its tag.

Parameters:

elementTag - the tag of the element which the behavior should be excluded from generation. Setting null makes the exclusion apply to all elements

behaviorName - the name of the behavior or mixin to be excluded

excludeInterface

public static void excludeInterface(String elementTag,
                                    Class<?> interfaceClass)

Excludes an interface from being evaluated for a specific element denoted by its tag.

Parameters:

elementTag - the tag of the element which the interface should be excluded from generation. Setting null makes the exclusion apply to all elements

interfaceClass - the class of the Interface to be excluded

isPropertyExcluded

public static boolean isPropertyExcluded(String elementTag,
                                         String propertyName,
                                         Set<ComponentBasicType> type)

Gets whether a property should be excluded or not from the generation.

Parameters:

elementTag - the tag of the element

propertyName - the name of the property

type - the type of the property

Returns:

true if the property should be excluded, false otherwise

isEventExcluded

public static boolean isEventExcluded(String elementTag,
                                      String eventName)

Gets whether an event should be excluded or not from the generation.

Parameters:

elementTag - the tag of the element

eventName - the name of the event

Returns:

true if the event should be excluded, false otherwise

isMethodExcluded

public static boolean isMethodExcluded(String elementTag,
                                       String methodName)

Gets whether a method should be excluded or not from the generation.

Parameters:

elementTag - the tag of the element

methodName - the name of the method

Returns:

true if the method should be excluded, false otherwise

isBehaviorOrMixinExcluded

public static boolean isBehaviorOrMixinExcluded(String elementTag,
                                                String behaviorName)

Gets whether a behavior or mixin should be excluded or not from the generation.

Parameters:

elementTag - the tag of the element

behaviorName - the name of the behavior or mixin

Returns:

true if the behavior should be excluded, false otherwise

isInterfaceExcluded

public static boolean isInterfaceExcluded(String elementTag,
                                          Class<?> interfaceClass)

Gets whether an interface should be excluded or not from the generation.

Parameters:

elementTag - the tag of the element

interfaceClass - the class of the interface

Returns:

true if the interface should be excluded, false otherwise