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: * Ruleset
23: *
24: * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
25: * @version $Id: Ruleset.java 516448 2007-03-09 16:25:47Z ate $
26: */
27: public interface Ruleset extends Identified {
28: /**
29: * Get the remove comments flag for removing comments from the markup source.
30: *
31: * @return true True if comments should be removed.
32: */
33: public boolean getRemoveComments();
34:
35: /**
36: * Set the remove comments flag for removing comments from the markup source.
37: *
38: * @param flag True if comments should be removed.
39: */
40: public void setRemoveComments(boolean flag);
41:
42: /**
43: * Given a tag identifier, lookup and return a tag object.
44: *
45: * @param tagId the unique tag identifier
46: * @return the tag object for the given identifier
47: */
48: Tag getTag(String tagId);
49:
50: /**
51: * Given a rule identifier, lookup and return a rule object.
52: *
53: * @param ruleId the unique rule identifier
54: * @return the rule object for the given identifier
55: */
56: Rule getRule(String ruleId);
57:
58: /**
59: * Get a collection of rules for this rule set.
60: *
61: * @return A collection of rules.
62: */
63: Collection getRules();
64:
65: /**
66: * Get a collection of markup tags for this rule set.
67: *
68: * @return A collection of markup tags.
69: */
70: public Collection getTags();
71:
72: /**
73: * Synchronize the Ruleset
74: *
75: */
76: void sync();
77:
78: }
|