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  
18  package org.apache.commons.jxpath.ri.model;
19  
20  import java.util.Locale;
21  
22  import org.apache.commons.jxpath.ri.QName;
23  
24  /**
25   * Creates NodePointers for objects of a certain type. NodePointerFactories are ordered according to the values returned by the "getOrder" method and always
26   * queried in that order.
27   */
28  public interface NodePointerFactory {
29  
30      /**
31       * Create a NodePointer for the supplied child object.
32       *
33       * @param parent parent node
34       * @param qName  node name
35       * @param object child object
36       * @return null if this factory does not recognize objects of the supplied type.
37       */
38      NodePointer createNodePointer(NodePointer parent, QName qName, Object object);
39  
40      /**
41       * Create a NodePointer for the supplied object. The node will represent the "root" object for a path.
42       *
43       * @param qName  node name
44       * @param object child object
45       * @param locale Locale
46       * @return null if this factory does not recognize objects of the supplied type.
47       */
48      NodePointer createNodePointer(QName qName, Object object, Locale locale);
49  
50      /**
51       * The factory order number determines its position between other factories.
52       *
53       * @return int order
54       */
55      int getOrder();
56  }