/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.commons.configuration.tree.xpath;

import java.util.Locale;

import org.apache.commons.configuration.tree.ConfigurationNode;
import org.apache.commons.jxpath.ri.QName;
import org.apache.commons.jxpath.ri.model.NodePointer;
import org.apache.commons.jxpath.ri.model.NodePointerFactory;

Implementation of the NodePointerFactory interface for configuration nodes. 
Author:
Commons
Configuration team
Since:
1.3
Version:
$Id: ConfigurationNodePointerFactory.java 1206498 2011-11-26 17:01:58Z oheger $/**
 * Implementation of the {@code NodePointerFactory} interface for
 * configuration nodes.
 *
 * @since 1.3
 * @author <a
 * href="http://commons.apache.org/configuration/team-list.html">Commons
 * Configuration team</a>
 * @version $Id: ConfigurationNodePointerFactory.java 1206498 2011-11-26 17:01:58Z oheger $
 */
public class ConfigurationNodePointerFactory implements NodePointerFactory
{
    
Constant for the order of this factory. /** Constant for the order of this factory. */
    public static final int CONFIGURATION_NODE_POINTER_FACTORY_ORDER = 200;

    
Returns the order of this factory between other factories.
Returns:
this order's factory/**
     * Returns the order of this factory between other factories.
     *
     * @return this order's factory
     */
    public int getOrder()
    {
        return CONFIGURATION_NODE_POINTER_FACTORY_ORDER;
    }

    
Creates a node pointer for the specified bean. If the bean is a
configuration node, a corresponding pointer is returned.
Params:
name – the name of the node
bean – the bean
locale – the locale
Returns:
a pointer for a configuration node if the bean is such a node/**
     * Creates a node pointer for the specified bean. If the bean is a
     * configuration node, a corresponding pointer is returned.
     *
     * @param name the name of the node
     * @param bean the bean
     * @param locale the locale
     * @return a pointer for a configuration node if the bean is such a node
     */
    public NodePointer createNodePointer(QName name, Object bean, Locale locale)
    {
        if (bean instanceof ConfigurationNode)
        {
            return new ConfigurationNodePointer((ConfigurationNode) bean,
                    locale);
        }
        return null;
    }

    
Creates a node pointer for the specified bean. If the bean is a
configuration node, a corresponding pointer is returned.
Params:
parent – the parent node
name – the name
bean – the bean
Returns:
a pointer for a configuration node if the bean is such a node/**
     * Creates a node pointer for the specified bean. If the bean is a
     * configuration node, a corresponding pointer is returned.
     *
     * @param parent the parent node
     * @param name the name
     * @param bean the bean
     * @return a pointer for a configuration node if the bean is such a node
     */
    public NodePointer createNodePointer(NodePointer parent, QName name,
            Object bean)
    {
        if (bean instanceof ConfigurationNode)
        {
            return new ConfigurationNodePointer(parent,
                    (ConfigurationNode) bean);
        }
        return null;
    }
}