org.apache.jackrabbit.commons.predicate.IsNodePredicate Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jackrabbit-jcr-commons Show documentation

General purpose classes for use with the JCR API

The newest version!

/*
 * 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.jackrabbit.commons.predicate;

import javax.jcr.Item;
import javax.jcr.RepositoryException;

/**
 * Item filter that checks if an item is a node.
 *
 */
public class IsNodePredicate extends DepthPredicate {

    /**
     * Polarity of this filter
     */
    protected final boolean isNode;

    /**
     * Default constructor.
     */
    public IsNodePredicate() {
        this(true);
    }

    /**
     * Creates a new node item filter.
     *
     * @param polarity the polarity of this filter. if true it matches
     * nodes, if false it matches properties.
     * @param minDepth the minimum depth
     * @param maxDepth the maximum depth
     *
     * @see DepthPredicate
     */
    public IsNodePredicate(boolean polarity, int minDepth, int maxDepth) {
        super(minDepth, maxDepth);
        isNode = polarity;
    }

    /**
     * Creates a new node item filter
     * @param polarity the polarity of this filter. if true it matches
     * nodes, if false it matches properties.
     */
    public IsNodePredicate(boolean polarity) {
        this(polarity, 0, Integer.MAX_VALUE);
    }

    /**
     * Returns true if the item is a node and the polarity is
     * positive (true).
     * @see org.apache.jackrabbit.commons.predicate.DepthPredicate#matches(javax.jcr.Item)
     */
    @Override
    protected boolean matches(Item item) throws RepositoryException {
        return item.isNode() == isNode;
    }
}