Module org.autogui

Package org.autogui.base.type

Class GuiTypeBuilder

java.lang.Object

org.autogui.base.type.GuiTypeBuilder

Direct Known Subclasses:

GuiTypeBuilder.GuiTypeBuilderRelaxed

public class GuiTypeBuilder
extends Object

the factory for GuiTypeElement. get(Type) can obtain a GuiTypeElement from Type. it's targets are members attached [at]GuiIncluded.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GuiTypeBuilder.GuiTypeBuilderRelaxed	another type-builder with relaxed rules: including non-public (without access-modifiers) members.
static class	GuiTypeBuilder.MemberDefinitions	a temporarily created member group in createObjectFromClass(Class,Type)
static class	GuiTypeBuilder.MemberDefinitionsForNotifier

Field Summary

Fields

Modifier and Type	Field	Description
protected static List<Class<?>>	langValueTypes
protected Map<Type,GuiTypeElement>	typeElements
protected List<Class<?>>	valueTypes

Constructor Summary

Constructors

Constructor	Description
GuiTypeBuilder()
GuiTypeBuilder(List<Class<?>> valueTypes)

Method Summary

Modifier and Type	Method	Description
GuiTypeElement	create(Type type)	for Class: createFromClass(Class) for ParameterizedType: obtain the raw class and check it is a Collection with a type arg <T>.
GuiTypeCollectionArray	createCollectionArrayFromClass(Class<?> cls, Type genericTypeOfCls)
GuiTypeCollection	createCollectionFromType(ParameterizedType type)
GuiTypeElement	createFromClass(Class<?> cls)
GuiTypeElement	createFromClass(Class<?> cls, Type genericTypeOfCls)
void	createMember(GuiTypeObject objType, GuiTypeBuilder.MemberDefinitions definitions)	if the definitions has a field, a getter or a setter, create a property.
void	createMemberAction(GuiTypeObject objType, String name, Method method, boolean isList)
void	createMemberProperty(GuiTypeObject objType, String name, Field fld, Method getter, Method setter)
void	createMemberProperty(GuiTypeObject objType, String name, Field fld, Method getter, Method setter, GuiTypeMemberProperty property)
void	createMemberPropertyNotifier(GuiTypeObject objType, String name, Field fld, Method getter, Method setter)
GuiTypeObject	createObjectFromClass(Class<?> cls, Type genericTypeOfCls)	create a GuiTypeObject, register it, and construct field and method members.
GuiTypeValue	createValueFromClass(Class<?> cls, Type genericTypeOfCls)
GuiTypeElement	get(Type type)	reuse a constructed type element, or create(Type).
Class<?>	getClass(Type type)	Class, raw type of ParameterizedType, LUB of WildcardType, LUB of TypeVariable, Object[] for GenericArrayType, or Object
String	getMemberNameFromField(Field f)
String	getMemberNameFromMethod(Method m)
String	getMemberNameFromMethodForAction(Method m)
String	getMemberNameFromMethodName(String name)
OptionalInt	getMemberOrdinalIndex(Field f)
OptionalInt	getMemberOrdinalIndex(Method m)
String	getNameSuffix(String head, String name)
List<Class<?>>	getValueTypes()
boolean	isAccessorMethod(Method m)
boolean	isActionListMethod(Method m)
boolean	isActionMethod(Method m)	Note: it might conflict with isAccessorMethod(Method)
boolean	isExcludedType(Class<?> cls)
boolean	isGetterMethod(Method m)
boolean	isGuiIncludedEnabled(AnnotatedElement e)
boolean	isIncludedClass(Class<?> cls)
boolean	isMemberField(Field f)
boolean	isMemberMethod(Method m)
boolean	isNotifierSetterMethod(Method m)
boolean	isSetterMethod(Method m)
boolean	isValueType(Class<?> cls)
List<Field>	listFields(Class<?> cls)
List<Method>	listMethods(Class<?> cls)
protected void	put(Type type, GuiTypeElement e)
void	setValueTypes(List<Class<?>> valueTypes)

Methods inherited from class java.lang.Object

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

Field Details

typeElements

protected Map<Type,GuiTypeElement> typeElements

langValueTypes

protected static List<Class<?>> langValueTypes

valueTypes

protected List<Class<?>> valueTypes

Constructor Details

GuiTypeBuilder

public GuiTypeBuilder()

GuiTypeBuilder

public GuiTypeBuilder(List<Class<?>> valueTypes)

Method Details

setValueTypes

public void setValueTypes(List<Class<?>> valueTypes)

getValueTypes

public List<Class<?>> getValueTypes()

Returns:

the default value types which are boxed primitive types: Integer etc.

get

public GuiTypeElement get(Type type)

reuse a constructed type element, or create(Type). the reusing can avoid infinity recursion

Parameters:

type - for the element

Returns:

the created type element

create

public GuiTypeElement create(Type type)

• for Class: createFromClass(Class)
• for ParameterizedType: obtain the raw class and check it is a Collection with a type arg <T>. then, createCollectionFromType(ParameterizedType), otherwise createFromClass(Class) for the raw type
• otherwise obtains the raw-type of the type, and createFromClass(Class, Type)
• if no raw-type, returns null

Parameters:

type - for creation

Returns:

nullable

createFromClass

public GuiTypeElement createFromClass(Class<?> cls)

Parameters:

cls - the target class

Returns:

if array class and isIncludedClass(Class), createCollectionArrayFromClass(Class,Type). if isValueType(Class) or isExcludedType(Class) then createValueFromClass(Class,Type) else createObjectFromClass(Class,Type)

createFromClass

public GuiTypeElement createFromClass(Class<?> cls,
 Type genericTypeOfCls)

isIncludedClass

public boolean isIncludedClass(Class<?> cls)

Parameters:

cls - the target class

Returns:

if array class, recursively checks component type. otherwise, isValueType(Class) or non-isExcludedType(Class)

createValueFromClass

public GuiTypeValue createValueFromClass(Class<?> cls,
 Type genericTypeOfCls)

Parameters:

cls - the target type

genericTypeOfCls - a generic type version of cls, which will also be registered. nullable.

Returns:

a new GuiTypeValue with registering it

createCollectionFromType

public GuiTypeCollection createCollectionFromType(ParameterizedType type)

Parameters:

type - the target type

Returns:

a new GuiTypeCollection with the raw type and the element type

createCollectionArrayFromClass

public GuiTypeCollectionArray createCollectionArrayFromClass(Class<?> cls,
 Type genericTypeOfCls)

createObjectFromClass

public GuiTypeObject createObjectFromClass(Class<?> cls,
 Type genericTypeOfCls)

create a GuiTypeObject, register it, and construct field and method members. those members are grouped by their names and passed to createMember(GuiTypeObject, MemberDefinitions). the rules for finding members are isMemberField(Field) and isMemberMethod(Method).

     //example
     @GuiIncluded
     class C {
         @GuiIncluded(index=1)
         public int fld;

         @GuiIncluded(index=2, description="read-only value")
         public String getReadOnlyProp() { ... }

         @GuiIncluded(index=3, description="property by setter and getter")
         public String getValue() { ... }
         public void setValue(String v) { ... }

         @GuiIncluded(index=4, description="action")
         public void action() { ... }
     }
 

Parameters:

cls - the object class

genericTypeOfCls - a generic type of cls, which is also registered. nullable

Returns:

an object type for the class

listFields

public List<Field> listFields(Class<?> cls)

listMethods

public List<Method> listMethods(Class<?> cls)

put

protected void put(Type type,
 GuiTypeElement e)

isValueType

public boolean isValueType(Class<?> cls)

Parameters:

cls - the tested class

Returns:

primitive or valueTypes

isExcludedType

public boolean isExcludedType(Class<?> cls)

isGuiIncludedEnabled

public boolean isGuiIncludedEnabled(AnnotatedElement e)

Parameters:

e - the target member

Returns:

true if e has the annotation GuiIncluded.value()==true

Since:

1.2

createMember

public void createMember(GuiTypeObject objType,
 GuiTypeBuilder.MemberDefinitions definitions)

if the definitions has a field, a getter or a setter, create a property. otherwise create actions. Note: any methods starting with "get", "set" or "is" are collected as a GuiTypeBuilder.MemberDefinitions. So, getM() and setM() are MemberDefinitions("m") and here create actions "Get M" and "Set M".

Parameters:

objType - the owner object

definitions - the members

createMemberProperty

public void createMemberProperty(GuiTypeObject objType,
 String name,
 Field fld,
 Method getter,
 Method setter)

createMemberPropertyNotifier

public void createMemberPropertyNotifier(GuiTypeObject objType,
 String name,
 Field fld,
 Method getter,
 Method setter)

createMemberProperty

public void createMemberProperty(GuiTypeObject objType,
 String name,
 Field fld,
 Method getter,
 Method setter,
 GuiTypeMemberProperty property)

getMemberOrdinalIndex

public OptionalInt getMemberOrdinalIndex(Method m)

getMemberOrdinalIndex

public OptionalInt getMemberOrdinalIndex(Field f)

createMemberAction

public void createMemberAction(GuiTypeObject objType,
 String name,
 Method method,
 boolean isList)

isMemberField

public boolean isMemberField(Field f)

Parameters:

f - the tested field

Returns:

true if GuiIncluded is attached and non-static

getMemberNameFromField

public String getMemberNameFromField(Field f)

Parameters:

f - the field

Returns:

the field name itself or attached GuiIncluded.name()

isMemberMethod

public boolean isMemberMethod(Method m)

Parameters:

m - the tested method

Returns:

true if GuiIncluded attached and non-static with excluding isNotifierSetterMethod(Method)

getMemberNameFromMethod

public String getMemberNameFromMethod(Method m)

Parameters:

m - a method

Returns:

getMemberNameFromMethodName(String) or attached GuiIncluded.name()

getMemberNameFromMethodForAction

public String getMemberNameFromMethodForAction(Method m)

Parameters:

m - a method

Returns:

the name of the method or attached GuiIncluded.name()

getMemberNameFromMethodName

public String getMemberNameFromMethodName(String name)

Parameters:

name - a method name

Returns:

suffix of get..., is.... or set..., or name itself

getNameSuffix

public String getNameSuffix(String head,
 String name)

isGetterMethod

public boolean isGetterMethod(Method m)

Parameters:

m - the tested method

Returns:

true if boolean is...() or V get...()

isAccessorMethod

public boolean isAccessorMethod(Method m)

Parameters:

m - the tested method

Returns:

true if T m(), no annotation GuiListSelectionUpdater and GuiIncluded.action()==false (or no GuiIncluded)

Since:

1.2

isSetterMethod

public boolean isSetterMethod(Method m)

Parameters:

m - the tested method

Returns:

set...(V v)

isActionMethod

public boolean isActionMethod(Method m)

Note: it might conflict with isAccessorMethod(Method)

Parameters:

m - the tested method

Returns:

true if m()

isActionListMethod

public boolean isActionListMethod(Method m)

Parameters:

m - the tested method

Returns:

m(L<E>) and L is a super type of List except for Object. or, m(L<E>, String)

getClass

public Class<?> getClass(Type type)

Class, raw type of ParameterizedType, LUB of WildcardType, LUB of TypeVariable, Object[] for GenericArrayType, or Object

Parameters:

type - the type for extraction

Returns:

an extracted class or Object.class

isNotifierSetterMethod

public boolean isNotifierSetterMethod(Method m)

Parameters:

m - the tested method

Returns:

true if the method is non-static and has GuiNotifierSetter with taking a Runnable argument