griffon.core.artifact

Interface GriffonClass

All Known Subinterfaces:

GriffonControllerClass, GriffonModelClass, GriffonServiceClass, GriffonViewClass

All Known Implementing Classes:

AbstractGriffonClass, DefaultGriffonClass, DefaultGriffonControllerClass, DefaultGriffonModelClass, DefaultGriffonServiceClass, DefaultGriffonViewClass

public interface GriffonClass

Represents any class in a Griffon application that is related to an artifact.

While GriffonArtifact points to the real artifact instance, this class points to the meta information that can be obtained from such artifact.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Set<java.lang.String>	STANDARD_PROPERTIES

Method Summary

Modifier and Type	Method and Description
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	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	getPropertyName() Returns the name of the class as a property 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
boolean	hasProperty(java.lang.String name) Returns true if the class has the specified property.

Field Detail

STANDARD_PROPERTIES

static final java.util.Set<java.lang.String> STANDARD_PROPERTIES

Method Detail

getApplication

@Nonnull
GriffonApplication getApplication()

getPropertyValue

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

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

Parameters:

name - The name of the property

Returns:

The initial value

hasProperty

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

Returns true if the class has the specified property.

Parameters:

name - The name of the property

Returns:

True if it does

getName

@Nonnull
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.

Returns:

the logical name

getShortName

@Nonnull
java.lang.String getShortName()

Returns the short name of the class without package prefix

Returns:

The short name

getFullName

@Nonnull
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.

Returns:

the full name

getPropertyName

@Nonnull
java.lang.String getPropertyName()

Returns the name of the class as a property name

Returns:

The property name representation

getLogicalPropertyName

@Nonnull
java.lang.String getLogicalPropertyName()

Returns the logical name of the class as a property name

Returns:

The logical property name

getNaturalName

@Nonnull
java.lang.String getNaturalName()

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

Returns:

The natural property name

getPackageName

@Nonnull
java.lang.String getPackageName()

Returns the package name of the class.

Returns:

the package name

getClazz

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

Returns the actual class represented by the GriffonClass

Returns:

the class

getArtifactType

@Nonnull
java.lang.String getArtifactType()

Returns the artifact type represented by the GriffonClass

Returns:

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

getPropertyValue

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

Obtains a property value for the given name and type.

Parameters:

name - The name

type - The type

Returns:

The property value