01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * 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: * Get a collection of attributes for the given Tag.
30: *
31: * @return A collection of attributes.
32: */
33: Collection getAttributes();
34:
35: /**
36: * Represents whether this tag is to be removed during rewrite phase.
37: * Removing a tag only removes the tag but not the contents in
38: * between the start and end tag.
39: *
40: * @return true if this tag should be removed
41: */
42: public boolean getRemove();
43:
44: /**
45: * Represents whether this tag is to be removed during rewrite phase.
46: * Removing a tag only removes the tag but not the contents in
47: * between the start and end tag.
48: *
49: * @param flag true if this tag should be removed
50: */
51: public void setRemove(boolean flag);
52:
53: /**
54: * Represents whether this tag is to be removed during rewrite phase.
55: * Stripping tags removes the start and end tag, plus all tags
56: * and content in between the start and end tag.
57: *
58: * @return true if this tag should be stripped.
59: */
60: public boolean getStrip();
61:
62: /**
63: * Represents whether this tag is to be removed during rewrite phase.
64: * Stripping tags removes the start and end tag, plus all tags
65: * and content in between the start and end tag.
66: *
67: * @param flag true if this tag should be stripped.
68: */
69: public void setStrip(boolean flag);
70:
71: }
|