org.schmant.arg
Class DirectoryRepresentation

java.lang.Object
  org.schmant.support.AbstractArgumentChecker
      org.schmant.arg.DirectoryRepresentation

public class DirectoryRepresentation
extends AbstractArgumentChecker

This is an representation of a directory and possibly an entity filter. It is returned from some ArgumentInterpreter methods.

It differs from DirectoryAndFilter in that that the directory in this object has been interpreted as a DirectoryView.

Since:

0.5

Author:

Karl Gustafsson

Constructor Summary

DirectoryRepresentation(DirectoryView dir, Filter<? super EntityView> f)
Create a new DirectoryRepresentation.

Method Summary

DirectoryView	getDirectory() Get the directory.
Filter<? super EntityView>	getFilter() Get the filter.
String	toString()

Methods inherited from class org.schmant.support.AbstractArgumentChecker

check, check, check, check

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DirectoryRepresentation

public DirectoryRepresentation(DirectoryView dir,
                               Filter<? super EntityView> f)

Create a new DirectoryRepresentation.

Parameters:

dir - The directory.

f - The filter. May be null.

Method Detail

getDirectory

public DirectoryView getDirectory()

Get the directory. This method tries to ensure that the returned directory is valid by calling Entities.getValidEntity(org.entityfs.EntityView).

getFilter

public Filter<? super EntityView> getFilter()

Get the filter.

Returns:

The filter. May be null.

toString

public String toString()

Overrides:

toString in class Object