AbstractGriffonClass (Griffon 2.2.0)

java.lang.Object
- org.codehaus.griffon.runtime.core.artifact.AbstractGriffonClass

All Implemented Interfaces:

GriffonClass

Direct Known Subclasses:

DefaultGriffonClass
```
public abstract class AbstractGriffonClass
extends 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 Set<String> eventsCache

protected Logger log
- Fields inherited from interface griffon.core.artifact.GriffonClass
  STANDARD_PROPERTIES

Fields
Modifier and Type	Field and Description
`protected Set<String>`	`eventsCache`
`protected Logger`	`log`

Constructor Summary

Constructors
Constructor and Description
`AbstractGriffonClass(GriffonApplication application, Class<?> type, String artifactType, String trailingName)`

Method Summary

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

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - eventsCache
```
protected final Set<String> eventsCache
```
  - log
```
protected final Logger log
```
- Constructor Detail
  - AbstractGriffonClass
```
public AbstractGriffonClass(@Nonnull
                            GriffonApplication application,
                            @Nonnull
                            Class<?> type,
                            @Nonnull
                            String artifactType,
                            @Nonnull
                            String trailingName)
```
- Method Detail
  - getApplication
```
@Nonnull
public GriffonApplication getApplication()
```
    Specified by:
    
    getApplication in interface GriffonClass
  - getPropertyValue
```
@Nullable
public Object getPropertyValue(@Nonnull
                                         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
                           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 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 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 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 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 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 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 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 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 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
                                        String name,
                                        @Nonnull
                                        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 String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(@Nullable
                      Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - resetCaches
```
public void resetCaches()
```
  - getEventNames
```
@Nonnull
public String[] getEventNames()
```
  - getPropertiesWithFields
```
public 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 Class<?> getPropertyType(String name)
```
  - isReadableProperty
```
public boolean isReadableProperty(String name)
```
  - getPropertyOrStaticPropertyOrFieldValue
```
protected Object getPropertyOrStaticPropertyOrFieldValue(@Nonnull
                                                         String name,
                                                         @Nonnull
                                                         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

Class AbstractGriffonClass

Field Summary

Fields inherited from interface griffon.core.artifact.GriffonClass

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

eventsCache

log

Constructor Detail

AbstractGriffonClass

Method Detail

getApplication

getPropertyValue

hasProperty

getName

getShortName

getFullName

getPropertyName

getLogicalPropertyName

getNaturalName

getPackageName

getClazz

getArtifactType

getPropertyValue

toString

equals

hashCode

resetCaches

getEventNames

getPropertiesWithFields

getPropertyType

isReadableProperty

getPropertyOrStaticPropertyOrFieldValue