View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.jetspeed.rewriter.rules;
18  
19  import java.util.Collection;
20  
21  /***
22   * Tag
23   *
24   * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
25   * @version $Id: Tag.java 516448 2007-03-09 16:25:47Z ate $
26   */
27  public interface Tag extends Identified
28  {
29      /***
30       * Get a collection of attributes for the given Tag.
31       * 
32       * @return A collection of attributes.
33       */
34      Collection getAttributes();
35      
36      
37      /***
38       * Represents whether this tag is to be removed during rewrite phase.
39       * Removing a tag only removes the tag but not the contents in 
40       * between the start and end tag.
41       * 
42       * @return true if this tag should be removed
43       */
44      public boolean getRemove();
45  
46      /***
47       * Represents whether this tag is to be removed during rewrite phase.
48       * Removing a tag only removes the tag but not the contents in 
49       * between the start and end tag.
50       * 
51       * @param flag true if this tag should be removed
52       */    
53      public void setRemove(boolean flag);
54  
55      /***
56       * Represents whether this tag is to be removed during rewrite phase.
57       * Stripping tags removes the start and end tag, plus all tags
58       * and content in between the start and end tag.
59       * 
60       * @return true if this tag should be stripped.
61       */
62      public boolean getStrip();
63  
64      /***
65       * Represents whether this tag is to be removed during rewrite phase.
66       * Stripping tags removes the start and end tag, plus all tags
67       * and content in between the start and end tag.
68       * 
69       * @param flag true if this tag should be stripped.
70       */    
71      public void setStrip(boolean flag);
72      
73  }