src/commons/org/codehaus/groovy/grails/commons/GrailsTagLibClass.java

   1 /* Copyright 2004-2005 the original author or authors.
   2  *
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at
   6  *
   7  *      http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 package org.codehaus.groovy.grails.commons;
  16
  17 import java.util.Set;
  18
  19 /**
  20  * <p>Represents a Grails tab library class</p>
  21  *
  22  * @author Graeme Rocher
  23  * @since Jan 14, 2006
  24  */
  25 public interface GrailsTagLibClass extends InjectableGrailsClass {
  26
  27         public static final String DEFAULT_NAMESPACE = "g";
  28
  29     /**
  30      * The name of the application (ie global) tag library appropriate for all controller classes
  31      */
  32     String SUPPORTS_CONTROLLER = "supportsController";
  33
  34     String NAMESPACE_FIELD_NAME = "namespace";
  35
  36     /**
  37      * Whether this tag library supports the specified controller
  38      * @param controllerClass The controllerClass to check
  39      * @return True if the controller is supported
  40      */
  41     boolean supportsController(GrailsControllerClass controllerClass);
  42
  43     /**
  44      *
  45      * @param tagName The name of the tag
  46      * @return Whether the tag library contains the specified tag
  47      */
  48     boolean hasTag(String tagName);
  49
  50     /**
  51      *
  52      * @return The tag names in this library
  53      */
  54     Set getTagNames();
  55
  56     /**
  57      *
  58      * @return the namespace that this taglib occupies.
  59      */
  60     String getNamespace();
  61 }