/*
 * 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.configuration2.tree.xpath;

import java.util.ArrayList;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;

import org.apache.commons.jxpath.ri.QName;
import org.apache.commons.jxpath.ri.model.NodePointer;
import org.apache.commons.lang3.StringUtils;

A specialized node iterator implementation that deals with attribute nodes.
Type parameters:
  • <T> – the type of the nodes this iterator deals with
/** * A specialized node iterator implementation that deals with attribute nodes. * * @param <T> the type of the nodes this iterator deals with */
class ConfigurationNodeIteratorAttribute<T> extends ConfigurationNodeIteratorBase<T> {
Constant for the wildcard node name.
/** Constant for the wildcard node name.*/
private static final String WILDCARD = "*";
Stores the parent node pointer.
/** Stores the parent node pointer. */
private final ConfigurationNodePointer<T> parentPointer;
A list with the names of the managed attributes.
/** A list with the names of the managed attributes. */
private final List<String> attributeNames;
Creates a new instance of ConfigurationNodeIteratorAttribute.
Params:
  • parent – the parent node pointer
  • name – the name of the selected attribute
/** * Creates a new instance of {@code ConfigurationNodeIteratorAttribute}. * @param parent the parent node pointer * @param name the name of the selected attribute */
public ConfigurationNodeIteratorAttribute( final ConfigurationNodePointer<T> parent, final QName name) { super(parent, false); parentPointer = parent; attributeNames = createAttributeDataList(parent, name); }
Creates a pointer for the node at the specified position.
Params:
  • position – the desired position
Returns:a pointer for the attribute at this position
/** * Creates a pointer for the node at the specified position. * * @param position the desired position * @return a pointer for the attribute at this position */
@Override protected NodePointer createNodePointer(final int position) { return new ConfigurationAttributePointer<>(parentPointer, attributeNames.get(position)); }
Returns the size of the managed iteration.
Returns:the iteration size
/** * Returns the size of the managed iteration. * * @return the iteration size */
@Override protected int size() { return attributeNames.size(); }
Determines which attributes are selected based on the passed in node name.
Params:
  • parent – the parent node pointer
  • name – the name of the selected attribute
Returns:a list with the selected attributes
/** * Determines which attributes are selected based on the passed in node * name. * * @param parent the parent node pointer * @param name the name of the selected attribute * @return a list with the selected attributes */
private List<String> createAttributeDataList( final ConfigurationNodePointer<T> parent, final QName name) { final List<String> result = new ArrayList<>(); if (!WILDCARD.equals(name.getName())) { addAttributeData(parent, result, qualifiedName(name)); } else { final Set<String> names = new LinkedHashSet<>(parent.getNodeHandler() .getAttributes(parent.getConfigurationNode())); final String prefix = name.getPrefix() != null ? prefixName(name.getPrefix(), null) : null; for (final String n : names) { if (prefix == null || StringUtils.startsWith(n, prefix)) { addAttributeData(parent, result, n); } } } return result; }
Helper method for checking whether an attribute is defined and adding it to the list of attributes to iterate over.
Params:
  • parent – the parent node pointer
  • result – the result list
  • name – the name of the current attribute
/** * Helper method for checking whether an attribute is defined and adding it * to the list of attributes to iterate over. * * @param parent the parent node pointer * @param result the result list * @param name the name of the current attribute */
private void addAttributeData(final ConfigurationNodePointer<T> parent, final List<String> result, final String name) { if (parent.getNodeHandler().getAttributeValue( parent.getConfigurationNode(), name) != null) { result.add(name); } } }