groovy/modules/grails/src/commons/org/codehaus/groovy/grails/commons/GrailsClass.java

/*
 * Copyright 2004-2005 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */ 
package org.codehaus.groovy.grails.commons;

import groovy.lang.GroovyObject;

/**
 * <p>This interface represents any class in a Grails application.
 * 
 * @author Steven Devijver
 * @since Jul 2, 2005
 */
public interface GrailsClass {

	/**
	 * <p>Creates a new instance of this class.
	 * 
	 * <p>This method can be used as factory method in the Spring application context.
	 */
	public GroovyObject newInstance();
	
	/**
	 * <p>Returns the logical name of the class in the application without the trailing convention part if applicable
	 * and without the package name.
	 * 
	 * @return the logical name
	 */
	public String getName();
	
	/**
	 * <p>Returns the full name of the class in the application with the the trailing convention part and with
	 * the package name.
	 * 
	 * @return the full name
	 */
	public String getFullName();
	
	/**
	 * <p>Returns the package name of the class.
	 * 
	 * @return the package name
	 */
	public String getPackageName();
	
	/**
	 * <p> Returns the actual clazz represented by the GrailsClass
	 * 
	 * @return the class
	 */
	public Class getClazz();
}