Package gw.internal.gosu.parser

Class JavaPropertyInfo

java.lang.Object

gw.lang.reflect.BaseFeatureInfo

gw.internal.gosu.parser.JavaBaseFeatureInfo

gw.internal.gosu.parser.JavaPropertyInfo

All Implemented Interfaces:

IAnnotatedFeatureInfo, IAttributedFeatureInfo, IFeatureInfo, IIntrinsicTypeReference, IMethodBackedPropertyInfo, IPropertyInfo, IJavaBasePropertyInfo, IJavaPropertyInfo

Direct Known Subclasses:

LengthProperty

public class JavaPropertyInfo
extends JavaBaseFeatureInfo
implements IJavaPropertyInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	JavaPropertyInfo.PropertyAccessorAdaptor

Nested classes/interfaces inherited from interface gw.lang.reflect.IAnnotatedFeatureInfo

IAnnotatedFeatureInfo.IAnnotationInfoHelper

Nested classes/interfaces inherited from interface gw.lang.reflect.IAttributedFeatureInfo

IAttributedFeatureInfo.MODIFIER

Field Summary

Fields

Modifier and Type	Field	Description
private IPropertyAccessor	_accessor
private LockingLazyVar<IJavaAnnotatedElement>	_annotatedElement
private IType	_assignablePropertyTypeWithTypeVars
private boolean	_bReadable
private Boolean	_bStatic
private IJavaClassMethod	_getMethod
private String	_name
private IJavaPropertyDescriptor	_pd
private IPresentationInfo	_presInfo
private IType	_propertyTypeWithTypeVars
private IJavaClassField	_publicField
private IJavaClassMethod	_setMethod

Fields inherited from interface gw.lang.reflect.IAnnotatedFeatureInfo

ANNOTATION_HELPER

Constructor Summary

Constructors

Modifier	Constructor	Description
(package private)	JavaPropertyInfo(IFeatureInfo container, IJavaPropertyDescriptor pd)
private	JavaPropertyInfo(IFeatureInfo container, IJavaPropertyDescriptor pd, IType propertyType)
private	JavaPropertyInfo(IFeatureInfo container, IJavaPropertyDescriptor pd, IType propertyType, IPresentationInfo presInfo)

Method Summary

Modifier and Type	Method	Description
private void	findFieldOn(IJavaClassInfo clazz, boolean setter)
IPropertyAccessor	getAccessor()
protected IJavaAnnotatedElement	getAnnotatedElement()
IType	getAssignableFeatureType()	The type this feature can be assigned from.
List<IAnnotationInfo>	getDeclaredAnnotations()
private IJavaClassInfo	getDeclaringClass()
String	getDeprecatedReason()
String	getDescription()	A full description of this feature.
String	getDisplayName()	Gets the display name of this feature.
IType	getFeatureType()	The type of this feature e.g., for a property this is the property's type.
ILocationInfo	getLocationInfo()
IDocRef<IMethodNode>	getMethodDocs()
String	getName()	Gets the programmatic name or identifier of this feature.
IPresentationInfo	getPresentationInfo()
IJavaPropertyDescriptor	getPropertyDescriptor()
IJavaClassField	getPublicField()
IMethodInfo	getReadMethodInfo()
String	getReturnDescription()
String	getShortDescription()
private IType	getTypeFromMethod(IJavaClassMethod m)
private IType[]	getTypesFromClasses(IJavaClassInfo[] types)
IMethodInfo	getWriteMethodInfo()
private void	initFlags()
boolean	isAbstract()
protected boolean	isDefaultEnumFeature()
boolean	isDeprecated()
boolean	isFinal()
protected boolean	isHiddenViaFeatureDescriptor()
boolean	isInternal()	True if this feature is internal.
boolean	isPrivate()	True if this feature is private.
boolean	isProtected()	True if this feature is protected.
boolean	isPublic()	True if this feature is public.
boolean	isReadable()
boolean	isStatic()	True if this feature is static, meaning the feature is not specific to a particular instance of the feature's containing type.
protected boolean	isVisibleViaFeatureDescriptor(IScriptabilityModifier constraint)
boolean	isWritable()
boolean	isWritable(IType whosAskin)
static IJavaPropertyInfo	newInstance(IFeatureInfo container, IJavaPropertyDescriptor pd)
static IJavaPropertyInfo	newInstance(IFeatureInfo container, IJavaPropertyDescriptor pd, IType propertyType)
static IJavaPropertyInfo	newInstance(IFeatureInfo container, IJavaPropertyDescriptor pd, IType propertyType, IPresentationInfo presInfo)
String	toString()

Methods inherited from class gw.internal.gosu.parser.JavaBaseFeatureInfo

isHidden, isVisible, makeDeprecated

Methods inherited from class gw.lang.reflect.BaseFeatureInfo

getAnnotation, getAnnotations, getAnnotationsOfType, getContainer, getOwnersType, getParamTypes, getSuperAnnotatedElements, hasAnnotation, hasDeclaredAnnotation, isDefaultImpl, isInternalAPI, isReified, isScriptable

Methods inherited from class java.lang.Object

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

Methods inherited from interface gw.lang.reflect.IAnnotatedFeatureInfo

getAnnotation, getAnnotations, getAnnotationsOfType, hasAnnotation, hasDeclaredAnnotation, isDefaultImpl

Methods inherited from interface gw.lang.reflect.IAttributedFeatureInfo

isHidden, isReified, isScriptable, isVisible

Methods inherited from interface gw.lang.reflect.IFeatureInfo

getContainer, getOwnersType

Methods inherited from interface gw.lang.reflect.IPropertyInfo

isReadable

Field Details

_pd

private IJavaPropertyDescriptor _pd

_propertyTypeWithTypeVars

private IType _propertyTypeWithTypeVars

_assignablePropertyTypeWithTypeVars

private IType _assignablePropertyTypeWithTypeVars

_accessor

private IPropertyAccessor _accessor

_bStatic

private Boolean _bStatic

_bReadable

private boolean _bReadable

_getMethod

private IJavaClassMethod _getMethod

_setMethod

private IJavaClassMethod _setMethod

_publicField

private IJavaClassField _publicField

_presInfo

private IPresentationInfo _presInfo

_name

private String _name

_annotatedElement

private LockingLazyVar<IJavaAnnotatedElement> _annotatedElement

Constructor Details

JavaPropertyInfo

JavaPropertyInfo(IFeatureInfo container,
 IJavaPropertyDescriptor pd)

Parameters:

container - Typically this will be the containing ITypeInfo

pd - The property descriptor (from BeanInfo)

JavaPropertyInfo

private JavaPropertyInfo(IFeatureInfo container,
 IJavaPropertyDescriptor pd,
 IType propertyType)

JavaPropertyInfo

private JavaPropertyInfo(IFeatureInfo container,
 IJavaPropertyDescriptor pd,
 IType propertyType,
 IPresentationInfo presInfo)

Method Details

newInstance

public static IJavaPropertyInfo newInstance(IFeatureInfo container,
 IJavaPropertyDescriptor pd)

newInstance

public static IJavaPropertyInfo newInstance(IFeatureInfo container,
 IJavaPropertyDescriptor pd,
 IType propertyType)

newInstance

public static IJavaPropertyInfo newInstance(IFeatureInfo container,
 IJavaPropertyDescriptor pd,
 IType propertyType,
 IPresentationInfo presInfo)

initFlags

private void initFlags()

findFieldOn

private void findFieldOn(IJavaClassInfo clazz,
 boolean setter)

getFeatureType

public IType getFeatureType()

Description copied from interface: IIntrinsicTypeReference

The type of this feature e.g., for a property this is the property's type.

Specified by:

getFeatureType in interface IIntrinsicTypeReference

getAssignableFeatureType

public IType getAssignableFeatureType()

Description copied from interface: IIntrinsicTypeReference

The type this feature can be assigned from. Most of the time this is the same type as getFeatureType(), however it can be different and when it is it should almost always be contravariant with getFeatureType().

A property setter method is the primary use-case. For instance:

   interface Foo {
     property Name: CharSequence
   }

   class FooImpl implements Foo {
     var _name: String
     override property get Name(): String {
       return _name
     }
     override property set Name( cs: CharSequence ) {
       _name = cs.toString()
     }
   }
 

Here FooImpl overrides Foo's Name property with covariance on the getter's return type. This establishes that Name wrt FooImpl is of type String. Yet Foo's setter method must be overridden as-is, a method cannot override another method with covariant parameters. So, in terms of FooImpl's Name property, the setter method is contravariant with String, which again is Name's type wrt of FooImpl. Therefore, FooImpl's Name property should implement getAssignableFeatureType() and return CharSequence.

Specified by:

getAssignableFeatureType in interface IIntrinsicTypeReference

getTypeFromMethod

private IType getTypeFromMethod(IJavaClassMethod m)

getDeclaringClass

private IJavaClassInfo getDeclaringClass()

isReadable

public boolean isReadable()

Specified by:

isReadable in interface IPropertyInfo

Returns:

true if the property is readable given the visibility constraint passed in, false otherwise.

isWritable

public boolean isWritable(IType whosAskin)

Specified by:

isWritable in interface IPropertyInfo

Parameters:

whosAskin - The type querying the property writability. For example, passing in the type the property is on will allow properties that have private access in the setter to be written to. Passing in an unrelated type will only allow properties that are to be written to.

Returns:

True if the property is writable given the visibility constraint passed in, false otherwise.

isWritable

public boolean isWritable()

Specified by:

isWritable in interface IPropertyInfo

Returns:

True if the property is writable given the visibility constraint passed in, false otherwise.

getDeclaredAnnotations

public List<IAnnotationInfo> getDeclaredAnnotations()

Specified by:

getDeclaredAnnotations in interface IAnnotatedFeatureInfo

Overrides:

getDeclaredAnnotations in class JavaBaseFeatureInfo

Returns:

A map of AnnotationInfo objects by type representing all the annotations associated with this feature, or an empty map if there are no annotations.

getMethodDocs

public IDocRef<IMethodNode> getMethodDocs()

Specified by:

getMethodDocs in interface IJavaPropertyInfo

getReturnDescription

public String getReturnDescription()

Specified by:

getReturnDescription in interface IJavaBasePropertyInfo

isStatic

public boolean isStatic()

Description copied from interface: IAttributedFeatureInfo

True if this feature is static, meaning the feature is not specific to a particular instance of the feature's containing type.

Specified by:

isStatic in interface IAttributedFeatureInfo

isPrivate

public boolean isPrivate()

Description copied from interface: IAttributedFeatureInfo

True if this feature is private. Private features are only accessible from within the type that owns them.

Specified by:

isPrivate in interface IAttributedFeatureInfo

Overrides:

isPrivate in class BaseFeatureInfo

isInternal

public boolean isInternal()

Description copied from interface: IAttributedFeatureInfo

True if this feature is internal. Internal features are accessible from within the type that owns them and from other types in the same namespace.

Specified by:

isInternal in interface IAttributedFeatureInfo

Overrides:

isInternal in class BaseFeatureInfo

isProtected

public boolean isProtected()

Description copied from interface: IAttributedFeatureInfo

True if this feature is protected. Protected features are accessible from within the type that owns them and from derived containers.

Specified by:

isProtected in interface IAttributedFeatureInfo

Overrides:

isProtected in class BaseFeatureInfo

isPublic

public boolean isPublic()

Description copied from interface: IAttributedFeatureInfo

True if this feature is public. Public features are not restricted.

Specified by:

isPublic in interface IAttributedFeatureInfo

Overrides:

isPublic in class BaseFeatureInfo

isAbstract

public boolean isAbstract()

Specified by:

isAbstract in interface IAttributedFeatureInfo

Overrides:

isAbstract in class BaseFeatureInfo

isFinal

public boolean isFinal()

Specified by:

isFinal in interface IAttributedFeatureInfo

Overrides:

isFinal in class BaseFeatureInfo

getAnnotatedElement

protected IJavaAnnotatedElement getAnnotatedElement()

Specified by:

getAnnotatedElement in class JavaBaseFeatureInfo

isVisibleViaFeatureDescriptor

protected boolean isVisibleViaFeatureDescriptor(IScriptabilityModifier constraint)

Specified by:

isVisibleViaFeatureDescriptor in class JavaBaseFeatureInfo

isHiddenViaFeatureDescriptor

protected boolean isHiddenViaFeatureDescriptor()

Specified by:

isHiddenViaFeatureDescriptor in class JavaBaseFeatureInfo

isDefaultEnumFeature

protected boolean isDefaultEnumFeature()

Specified by:

isDefaultEnumFeature in class JavaBaseFeatureInfo

isDeprecated

public boolean isDeprecated()

Specified by:

isDeprecated in interface IAnnotatedFeatureInfo

Overrides:

isDeprecated in class BaseFeatureInfo

Returns:

True if this feature is deprecated.

getDeprecatedReason

public String getDeprecatedReason()

Specified by:

getDeprecatedReason in interface IAnnotatedFeatureInfo

Overrides:

getDeprecatedReason in class BaseFeatureInfo

Returns:

The deprecation message, or null if the feature is not deprecated.

getAccessor

public IPropertyAccessor getAccessor()

Specified by:

getAccessor in interface IPropertyInfo

Returns:

the PropertyAccessor (for getting and setting) this property.

getPresentationInfo

public IPresentationInfo getPresentationInfo()

Specified by:

getPresentationInfo in interface IPropertyInfo

getName

public String getName()

Description copied from interface: IFeatureInfo

Gets the programmatic name or identifier of this feature. Note this name should follow Java identifier naming conventions (alpha-num and underscores, but can't start with a digit).

Specified by:

getName in interface IFeatureInfo

getDisplayName

public String getDisplayName()

Description copied from interface: IFeatureInfo

Gets the display name of this feature. There is no guarantee this display name is localized.

Specified by:

getDisplayName in interface IFeatureInfo

Overrides:

getDisplayName in class BaseFeatureInfo

getShortDescription

public String getShortDescription()

Specified by:

getShortDescription in interface IJavaPropertyInfo

getDescription

public String getDescription()

Description copied from interface: IFeatureInfo

A full description of this feature.

Specified by:

getDescription in interface IFeatureInfo

Overrides:

getDescription in class BaseFeatureInfo

getReadMethodInfo

public IMethodInfo getReadMethodInfo()

Specified by:

getReadMethodInfo in interface IJavaPropertyInfo

Specified by:

getReadMethodInfo in interface IMethodBackedPropertyInfo

getPublicField

public IJavaClassField getPublicField()

Specified by:

getPublicField in interface IJavaPropertyInfo

getWriteMethodInfo

public IMethodInfo getWriteMethodInfo()

Specified by:

getWriteMethodInfo in interface IJavaPropertyInfo

Specified by:

getWriteMethodInfo in interface IMethodBackedPropertyInfo

getTypesFromClasses

private IType[] getTypesFromClasses(IJavaClassInfo[] types)

toString

public String toString()

Overrides:

toString in class BaseFeatureInfo

getPropertyDescriptor

public IJavaPropertyDescriptor getPropertyDescriptor()

Specified by:

getPropertyDescriptor in interface IJavaPropertyInfo

getLocationInfo

public ILocationInfo getLocationInfo()

Specified by:

getLocationInfo in interface IFeatureInfo