Britt Park beb44ec6ae Big rearrangement of package structure to allow as many classes
and interfaces to be package local as possible.


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/WCM-DEV2/root@3381 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2006-07-23 14:59:28 +00:00

98 lines
2.9 KiB
Java

/*
* Copyright (C) 2006 Alfresco, Inc.
*
* Licensed under the Mozilla Public License version 1.1
* with a permitted attribution clause. You may obtain a
* copy of the License at
*
* http://www.alfresco.org/legal/license.txt
*
* 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.alfresco.repo.avm;
import java.util.Map;
import java.util.SortedMap;
/**
* The interface for Directory Nodes.
* @author britt
*/
interface DirectoryNode extends AVMNode
{
/**
* Does this directory directly contain the specified node.
* @param node The node to check.
* @return Whether it does.
*/
public boolean directlyContains(AVMNode node);
/**
* Put child into this directory directly. No copy on write.
* @param name The name to give it.
* @param node The child.
*/
public void putChild(String name, AVMNode node);
/**
* Lookup a child node.
* @param lPath The Lookup so far.
* @param name The name of the child to lookup.
* @param version The version to look under.
* @param write Whether this is occuring in a write context.
*/
public AVMNode lookupChild(Lookup lPath, String name, int version, boolean write);
/**
* Lookup a child node using an AVMNodeDescriptor as context.
* @param mine The node descriptor for this.
* @param name The name of the child to lookup.
* @return The descriptor for the looked up child.
*/
public AVMNodeDescriptor lookupChild(AVMNodeDescriptor mine, String name);
/**
* Remove a child directly. No copy is possible.
* @param name The name of the child to remove.
*/
public void removeChild(String name);
/**
* Get a directory listing.
* @param lPath The lookup context.
* @return A SortedMap of names to DirectoryEntries.
*/
public Map<String, AVMNode> getListing(Lookup lPath);
/**
* Get a listing from a directory specified by an AVMNodeDescriptor.
* @param dir The directory to list.
* @return A Map of names to node descriptors
*/
public SortedMap<String, AVMNodeDescriptor> getListing(AVMNodeDescriptor dir);
/**
* Set the directory, which must be in a layer, into a primary
* indirection taking its indirection from the Lookup.
* @param lPath The Lookup.
*/
public void turnPrimary(Lookup lPath);
/**
* Retarget a layered directory.
* @param lPath The Lookup.
* @param target The target path.
*/
public void retarget(Lookup lPath, String target);
/**
* Set whether this node is a root node.
* @param isRoot
*/
public void setIsRoot(boolean isRoot);
}