org.codehaus.griffon.runtime.core.artifact

Class AbstractGriffonClass

java.lang.Object

org.codehaus.griffon.runtime.core.artifact.AbstractGriffonClass

All Implemented Interfaces:

GriffonClass

Direct Known Subclasses:

DefaultGriffonClass

public abstract class AbstractGriffonClass
extends java.lang.Object
implements GriffonClass

Abstract base class for Griffon types that provides common functionality for evaluating conventions within classes

Since:

2.0.0

Author:

Steven Devijver (Grails 0.1), Graeme Rocher (Grails 0.1), Andres Almiray

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<java.lang.String>	eventsCache
protected org.slf4j.Logger	log

Fields inherited from interface griffon.core.artifact.GriffonClass

STANDARD_PROPERTIES

Constructor Summary

Constructors

Constructor and Description
AbstractGriffonClass(GriffonApplication application, java.lang.Class<?> type, java.lang.String artifactType, java.lang.String trailingName)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
GriffonApplication	getApplication()
java.lang.String	getArtifactType() Returns the artifact type represented by the GriffonClass
java.lang.Class<?>	getClazz() Returns the actual class represented by the GriffonClass
java.lang.String[]	getEventNames()
java.lang.String	getFullName() Returns the full name of the class in the application with the the trailing convention part and with the package name.
java.lang.String	getLogicalPropertyName() Returns the logical name of the class as a property name
java.lang.String	getName() Returns the logical name of the class in the application without the trailing convention part if applicable and without the package name.
java.lang.String	getNaturalName() Returns the name of the property in natural terms (eg.
java.lang.String	getPackageName() Returns the package name of the class.
java.lang.String[]	getPropertiesWithFields() Returns an array of property names that are backed by a filed with a matching name.
java.lang.String	getPropertyName() Returns the name of the class as a property name
protected java.lang.Object	getPropertyOrStaticPropertyOrFieldValue(java.lang.String name, java.lang.Class<?> type) Looks for a property of the reference instance with a given name and type.
java.lang.Class<?>	getPropertyType(java.lang.String name)
java.lang.Object	getPropertyValue(java.lang.String name) Gets the initial value of the given property on the class.
<T> T	getPropertyValue(java.lang.String name, java.lang.Class<T> type) Obtains a property value for the given name and type.
java.lang.String	getShortName() Returns the short name of the class without package prefix
int	hashCode()
boolean	hasProperty(java.lang.String name) Returns true if the class has the specified property.
boolean	isReadableProperty(java.lang.String name)
void	resetCaches()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

eventsCache

protected final java.util.Set<java.lang.String> eventsCache

log

protected final org.slf4j.Logger log

Constructor Detail

AbstractGriffonClass

public AbstractGriffonClass(@Nonnull
                            GriffonApplication application,
                            @Nonnull
                            java.lang.Class<?> type,
                            @Nonnull
                            java.lang.String artifactType,
                            @Nonnull
                            java.lang.String trailingName)

Method Detail

getApplication

@Nonnull
public GriffonApplication getApplication()

Specified by:

getApplication in interface GriffonClass

getPropertyValue

@Nullable
public java.lang.Object getPropertyValue(@Nonnull
                                                   java.lang.String name)

Description copied from interface: GriffonClass

Gets the initial value of the given property on the class.

Specified by:

getPropertyValue in interface GriffonClass

Parameters:

name - The name of the property

Returns:

The initial value

hasProperty

public boolean hasProperty(@Nonnull
                           java.lang.String name)

Description copied from interface: GriffonClass

Returns true if the class has the specified property.

Specified by:

hasProperty in interface GriffonClass

Parameters:

name - The name of the property

Returns:

True if it does

getName

@Nonnull
public java.lang.String getName()

Description copied from interface: GriffonClass

Returns the logical name of the class in the application without the trailing convention part if applicable and without the package name.

Specified by:

getName in interface GriffonClass

Returns:

the logical name

getShortName

@Nonnull
public java.lang.String getShortName()

Description copied from interface: GriffonClass

Returns the short name of the class without package prefix

Specified by:

getShortName in interface GriffonClass

Returns:

The short name

getFullName

@Nonnull
public java.lang.String getFullName()

Description copied from interface: GriffonClass

Returns the full name of the class in the application with the the trailing convention part and with the package name.

Specified by:

getFullName in interface GriffonClass

Returns:

the full name

getPropertyName

@Nonnull
public java.lang.String getPropertyName()

Description copied from interface: GriffonClass

Returns the name of the class as a property name

Specified by:

getPropertyName in interface GriffonClass

Returns:

The property name representation

getLogicalPropertyName

@Nonnull
public java.lang.String getLogicalPropertyName()

Description copied from interface: GriffonClass

Returns the logical name of the class as a property name

Specified by:

getLogicalPropertyName in interface GriffonClass

Returns:

The logical property name

getNaturalName

@Nonnull
public java.lang.String getNaturalName()

Description copied from interface: GriffonClass

Returns the name of the property in natural terms (eg. 'lastName' becomes 'Last Name').

Specified by:

getNaturalName in interface GriffonClass

Returns:

The natural property name

getPackageName

@Nonnull
public java.lang.String getPackageName()

Description copied from interface: GriffonClass

Returns the package name of the class.

Specified by:

getPackageName in interface GriffonClass

Returns:

the package name

getClazz

@Nonnull
public java.lang.Class<?> getClazz()

Description copied from interface: GriffonClass

Returns the actual class represented by the GriffonClass

Specified by:

getClazz in interface GriffonClass

Returns:

the class

getArtifactType

@Nonnull
public java.lang.String getArtifactType()

Description copied from interface: GriffonClass

Returns the artifact type represented by the GriffonClass

Specified by:

getArtifactType in interface GriffonClass

Returns:

the artifact type, i.e. "controller".

getPropertyValue

@Nullable
public <T> T getPropertyValue(@Nonnull
                                        java.lang.String name,
                                        @Nonnull
                                        java.lang.Class<T> type)

Description copied from interface: GriffonClass

Obtains a property value for the given name and type.

Specified by:

getPropertyValue in interface GriffonClass

Parameters:

name - The name

type - The type

Returns:

The property value

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(@Nullable
                      java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

resetCaches

public void resetCaches()

getEventNames

@Nonnull
public java.lang.String[] getEventNames()

getPropertiesWithFields

public java.lang.String[] getPropertiesWithFields()

Returns an array of property names that are backed by a filed with a matching name.

Fields must be private and non-static. Names will be returned in the order they are declared in the class, starting from the deepest class in the class hierarchy up to the topmost superclass != null

getPropertyType

public java.lang.Class<?> getPropertyType(java.lang.String name)

isReadableProperty

public boolean isReadableProperty(java.lang.String name)

getPropertyOrStaticPropertyOrFieldValue

protected java.lang.Object getPropertyOrStaticPropertyOrFieldValue(@Nonnull
                                                                   java.lang.String name,
                                                                   @Nonnull
                                                                   java.lang.Class<?> type)

Looks for a property of the reference instance with a given name and type.

If found its value is returned. We follow the Java bean conventions with augmentation for groovy support and static fields/properties. We will therefore match, in this order:

1. Public static field
2. Public static property with getter method
3. Standard public bean property (with getter or just public field, using normal introspection)

Returns:

property value or null if no property or static field was found