org.apache.jackrabbit.spi.ItemInfo Maven / Gradle / Ivy

/*
 * 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.spi;

/**
 * The ItemInfo is the base interface of {@link NodeInfo}
 * and {@link PropertyInfo}.
 */
public interface ItemInfo {

    /**
     * @return identifier for the item that is based on this info object. the id
     * can either be an absolute path or a uniqueID (+ relative path).
     * @see RepositoryService#getNodeInfo(SessionInfo, NodeId)
     */
    public ItemId getId();

    /**
     * Returns true if this ItemInfo denotes a node, false otherwise.
     *
     * @return true if this ItemInfo denotes a node, false otherwise.
     */
    public boolean denotesNode();

    /**
     * Returns the Path of the item represented by this
     * ItemInfo.
     *
     * @return the Path of the item represented by this
     * item info.
     */
    public Path getPath();
}