org.pfsw.file.cfiles

Class AbstractContainer

java.lang.Object

org.pfsw.file.cfiles.AbstractContainer

All Implemented Interfaces:

IReleasable, IContainer, INamedElement

Direct Known Subclasses:

AbstractSubContainer, RootFolder, WindowsDrive

public abstract class AbstractContainer
extends java.lang.Object
implements IContainer

Abstract implementation of a container that holds multiple items.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractContainer()
protected	AbstractContainer(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	addItem(IItem... items) Adds one or more items to this container.
void	appendNameTo(java.lang.StringBuilder builder) Adds the name representation (which might be more than just the name itself)) to the given builder.
protected void	basicAdd(IItem item) Adds the given item if it s not null and if it is not yet in the item list and sets this container as the container of the given item.
protected boolean	basicEquals(java.lang.Object obj) Compares just the names of the objects.
protected int	basicHashCode() Calculates just the hash code from the underlying name.
protected void	basicRemove(IItem item) Adds the given item if it s not null and if it is not yet in the item list.
protected boolean	contains(IItem item)
boolean	equals(java.lang.Object obj)
protected java.util.List<IItem>	getItemList()
java.util.List<IItem>	getItems() Returns all items of this container.
java.lang.String	getName() Returns the name of the element.
int	hashCode()
boolean	isEmpty() Returns whether or not this container contains items.
void	release() Release any resources that should not be referred to anymore in order to let the garbage collector take care of them.
void	removeItem(IItem... items) Removes one or more items from this container.
void	setName(java.lang.String name)
int	size() Returns the number of currently contained items;
java.lang.String	toString() This is a debug method and to intended to be used for business logic.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractContainer

protected AbstractContainer()

AbstractContainer

protected AbstractContainer(java.lang.String name)

Method Detail

getItems

public java.util.List<IItem> getItems()

Description copied from interface: IContainer

Returns all items of this container. This will always be a copy of any internal list representation. That is, manipulating the returned list has no impact on the container's list of elements.

Specified by:

getItems in interface IContainer

Returns:

A list with all items (maybe empty). Never null.

size

public int size()

Description copied from interface: IContainer

Returns the number of currently contained items;

Specified by:

size in interface IContainer

Returns:

The number of items in the range of 0 - MAX_INT.

isEmpty

public boolean isEmpty()

Description copied from interface: IContainer

Returns whether or not this container contains items.

Specified by:

isEmpty in interface IContainer

Returns:

true if the container contains at least one item.

addItem

public void addItem(IItem... items)

Description copied from interface: IContainer

Adds one or more items to this container. That implies that the container sets itself as the container of the item.

Specified by:

addItem in interface IContainer

Parameters:

items - One or more items to be added.

removeItem

public void removeItem(IItem... items)

Description copied from interface: IContainer

Removes one or more items from this container. If a given item is not in the container, it will be silently ignored. Each item removed will also be detached from this container by calling its IReleasable.release() method.

Specified by:

removeItem in interface IContainer

Parameters:

items - One or more items to be removed.

release

public void release()

Description copied from interface: IReleasable

Release any resources that should not be referred to anymore in order to let the garbage collector take care of them. Usually after calling this method the receiver cannot be used anymore.

Specified by:

release in interface IReleasable

getName

public java.lang.String getName()

Description copied from interface: INamedElement

Returns the name of the element.

Specified by:

getName in interface INamedElement

Returns:

The name or null if none is defined yet.

appendNameTo

public void appendNameTo(java.lang.StringBuilder builder)

Description copied from interface: INamedElement

Adds the name representation (which might be more than just the name itself)) to the given builder.

Specified by:

appendNameTo in interface INamedElement

Parameters:

builder - The builder to which the name representation must be added.

setName

public void setName(java.lang.String name)

toString

public java.lang.String toString()

This is a debug method and to intended to be used for business logic.

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

basicAdd

protected void basicAdd(IItem item)

Adds the given item if it s not null and if it is not yet in the item list and sets this container as the container of the given item.

Parameters:

item - The item to add.

basicRemove

protected void basicRemove(IItem item)

Adds the given item if it s not null and if it is not yet in the item list.

Parameters:

item - The item to add.

contains

protected boolean contains(IItem item)

basicHashCode

protected int basicHashCode()

Calculates just the hash code from the underlying name.

basicEquals

protected boolean basicEquals(java.lang.Object obj)

Compares just the names of the objects.

getItemList

protected java.util.List<IItem> getItemList()