Package megamek.common.util.fileUtils

Class AbstractDirectory

java.lang.Object

megamek.common.util.fileUtils.AbstractDirectory

Direct Known Subclasses:

DirectoryItems

public abstract class AbstractDirectory
extends Object

AbstractDirectory is a class that is used to define a directory.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDirectory(File file, String rootName, String rootPath, ItemFileFactory itemFileFactory)

Method Summary

Modifier and Type	Method	Description
Map<String,AbstractDirectory>	getCategories()
AbstractDirectory	getCategory(String categoryPath)
Object	getItem(String categoryName, String itemName)	Get the indicated item from the correct category.
Iterator<String>	getItemNames(String categoryName)	Get the names of all the items in one of the categories.
Map<String,ItemFile>	getItems()
List<String>	getNonEmptyCategoryPaths()
String	getRootName()
String	getRootPath()
void	merge(AbstractDirectory other)	Adds the given AbstractDirectory's contents to this one's.
void	setRootName(String rootName)
void	setRootPath(String rootPath)

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractDirectory

protected AbstractDirectory(File file,
 @Nullable
 String rootName,
 @Nullable
 String rootPath,
 ItemFileFactory itemFileFactory)
                     throws NullPointerException

Parameters:

file - the directory file, included to ensure that is it not null

rootName - the root directory name

itemFileFactory - this is included to ensure that it is not null, as that is required for the files to be processed

Throws:

NullPointerException

Method Details

getRootName

public String getRootName()

setRootName

public void setRootName(String rootName)

getRootPath

public String getRootPath()

setRootPath

public void setRootPath(String rootPath)

getCategories

public Map<String,AbstractDirectory> getCategories()

getCategory

@Nullable
public AbstractDirectory getCategory(String categoryPath)

getNonEmptyCategoryPaths

public List<String> getNonEmptyCategoryPaths()

getItems

public Map<String,ItemFile> getItems()

getItemNames

public Iterator<String> getItemNames(@Nullable
 String categoryName)

Get the names of all the items in one of the categories.

Parameters:

categoryName - the String name of the category whose item names are required.

Returns:

an Iterator of String names. This value will not be null, but it may be empty.

getItem

@Nullable
public Object getItem(@Nullable
 String categoryName,
 String itemName)
               throws Exception

Get the indicated item from the correct category.

Parameters:

categoryName - the String name of the category whose item names are required

itemName - the String name of the indicated item

Returns:

the Object in the given category with the given name

Throws:

Exception - if there's any error getting the item

merge

public void merge(AbstractDirectory other)

Adds the given AbstractDirectory's contents to this one's. Note: equally named categories are integrated into one another, but for items in the exact same category (file path) and with the same name the item of other will replace the item in this AbstractDirectory.

Parameters:

other - The AbstractDirectory to merge into this one