com.phloc.commons.tree.withid.folder.DefaultFolderTree Maven / Gradle / Ivy
/**
* Copyright (C) 2006-2014 phloc systems
* http://www.phloc.com
* office[at]phloc[dot]com
*
* Licensed 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 com.phloc.commons.tree.withid.folder;
import java.util.Collection;
import java.util.Set;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;
import com.phloc.commons.combine.ICombinator;
/**
* Root class for a simple tree. The elements of the tree are not sorted by any
* means.
*
* @param
* The type of the element keys.
* @param
* The type of the elements contained in the tree
* @param
* the collection type consisting of value elements
* @author Philip Helger
*/
@NotThreadSafe
public class DefaultFolderTree > extends
BasicFolderTree >
{
/**
* Constructor that creates a {@link DefaultFolderTreeItemFactory} using the
* passed key combinator.
*
* @param aKeyCombinator
* The key combinator to be used. May be null
.
*/
public DefaultFolderTree (@Nullable final ICombinator aKeyCombinator)
{
this (new DefaultFolderTreeItemFactory (aKeyCombinator));
}
/**
* Constructor
*
* @param aFactory
* The item factory to use. May not be null
.
*/
public DefaultFolderTree (@Nonnull final IFolderTreeItemFactory > aFactory)
{
super (aFactory);
}
/**
* Create a new {@link DefaultFolderTree} using a set as the container.
*
* @param aKeyCombinator
* The key combinator to be used
* @return The created default folder tree
*/
@Nonnull
public static DefaultFolderTree > createForSet (@Nonnull final ICombinator aKeyCombinator)
{
return new DefaultFolderTree > (aKeyCombinator);
}
}