View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package javax.faces.view.facelets;
20  
21  /**
22   * A mutable set of rules to be used in auto-wiring state to a particular object instance. Rules assigned to this object
23   * will be composed into a single Metadata instance.
24   */
25  public abstract class MetaRuleset
26  {
27      /**
28       * @param mapper
29       * @return
30       */
31      public abstract MetaRuleset add(Metadata mapper);
32  
33      /**
34       * @param rule
35       * @return
36       */
37      public abstract MetaRuleset addRule(MetaRule rule);
38  
39      /**
40       * @param attribute
41       * @param property
42       * @return
43       */
44      public abstract MetaRuleset alias(String attribute, String property);
45  
46      /**
47       * @return
48       */
49      public abstract Metadata finish();
50  
51      /**
52       * @param attribute
53       * @return
54       */
55      public abstract MetaRuleset ignore(String attribute);
56  
57      /**
58       * @return
59       */
60      public abstract MetaRuleset ignoreAll();
61  }