org.linguafranca.pwdb

Interface Group<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>

All Known Implementing Classes:

AbstractGroup

public interface Group<D extends Database<D,G,E,I>,G extends Group<D,G,E,I>,E extends Entry<D,G,E,I>,I extends Icon>

Interface for a Database Group.

Databases have exactly one Root Group.

Other Groups of the database are a child of another Group.

A Database may contain Groups to an indefinite level.

Any Group may contain Entry items.

Groups have a name, a UUID and an Icon.

Author:

Jo

Method Summary

Modifier and Type	Method and Description
E	addEntry(E entry) Adds an entry to this group removing it from another group if it was part of one.
G	addGroup(G group) If the group belongs to this database then move it from its present parent, if any, to the group on which this method is called.
void	copy(Group<? extends Database,? extends Group,? extends Entry,? extends Icon> parent) Make a deep copy of the children a group and add to this group.
List<? extends E>	findEntries(Entry.Matcher matcher, boolean recursive) Finds all entries in this group that match using the matcher supplied.
List<? extends E>	findEntries(String match, boolean recursive) Finds all entries in this group that match the string supplied.
List<? extends G>	findGroups(String groupName) Returns a list of child Groups whose name exactly matches that supplied.
D	getDatabase() Get the database this group was created from
List<? extends E>	getEntries() Returns a modifiable by the caller list of entries contained in this group.
int	getEntriesCount() Returns the number of entries in this group
List<? extends G>	getGroups() Returns a list of groups that are the children of this group.
int	getGroupsCount() Returns the number of groups that are direct children of this group
Icon	getIcon() Get the Icon of this group
String	getName() Get the name of this group
G	getParent() Returns the parent of this group, or null if either this group is the root group, or if the group does not have a parent - e.g.
String	getPath() Returns an XPath-like string of the names of Groups from the Root to this Group.
UUID	getUuid() Get the UUID of this group
boolean	isRecycleBin() Returns true if this is the recycle bin of a database
boolean	isRootGroup() Returns true if this is the root group of a database
E	removeEntry(E entry) Remove an entry from this group and hence from the database.
G	removeGroup(G group) Removes the group supplied from this group.
void	setIcon(I icon) Set the Icon of this group
void	setName(String name) Set the name of this group
void	setParent(G parent) Add this group to a parent.

Method Detail

isRootGroup

boolean isRootGroup()

Returns true if this is the root group of a database

isRecycleBin

boolean isRecycleBin()

Returns true if this is the recycle bin of a database

getParent

@Nullable
G getParent()

Returns the parent of this group, or null if either this group is the root group, or if the group does not have a parent - e.g. if it is newly created or if it has been removed from a previous parent.

setParent

void setParent(G parent)

Add this group to a parent. The group must be of a type compatible with the database and if it already belongs to another group it is removed from that group.

Parameters:

parent - a prospective parent

getGroups

List<? extends G> getGroups()

Returns a list of groups that are the children of this group.

The list returned is modifiable by the caller without affecting the status of the database.

Returns:

a modifiable list of groups

getGroupsCount

int getGroupsCount()

Returns the number of groups that are direct children of this group

It's possible that returning a list as in getGroups() may incur significantly more overhead so use this method if only the count is reuqired

addGroup

G addGroup(G group)

If the group belongs to this database then move it from its present parent, if any, to the group on which this method is called.

The root group cannot be added to another group.

Parameters:

group - the group to add

Returns:

the group added

findGroups

List<? extends G> findGroups(String groupName)

Returns a list of child Groups whose name exactly matches that supplied.

The returned list may be modified without affecting the underlying database.

Parameters:

groupName - the name of the groups sought

Returns:

a modifiable list

removeGroup

G removeGroup(G group)

Removes the group supplied from this group. The group removed no longer has a parent and so in not part of the database any more unless it is re-added to another group.

If the group is incompatible with the databse an exception is thrown.

If the group is not present no error is thrown.

Parameters:

group - the group to remove

Returns:

the group passed for removal

Throws:

IllegalArgumentException - if the group is not a child of this group

getEntries

List<? extends E> getEntries()

Returns a modifiable by the caller list of entries contained in this group.

getEntriesCount

int getEntriesCount()

Returns the number of entries in this group

It's possible that returning a list as in getEntries() may incur significantly more overhead so use this method if only the count is reuqired

findEntries

List<? extends E> findEntries(String match,
                              boolean recursive)

Finds all entries in this group that match the string supplied. Optionally recurse over subgroups, excluding recycle bin.

Entry match is described under Entry.match(String)

Note: finding within recycle bin is supported, recusion into recycle bin is inhibited

Parameters:

match - the text to match

recursive - whether to include sub groups in the process

Returns:

a modifiable-by-caller list

See Also:

Entry.match(String)

findEntries

List<? extends E> findEntries(Entry.Matcher matcher,
                              boolean recursive)

Finds all entries in this group that match using the matcher supplied. Optionally recurse over subgroups, excluding recycle bin.

Entry match is described under Entry.match(Entry.Matcher)

Note: finding within recycle bin is supported, recusion into recycle bin is inhibited

Parameters:

matcher - the mathcher to use

recursive - whether to include sub groups in the process

Returns:

a modifiable-by-caller list

See Also:

Entry.match(Entry.Matcher)

addEntry

E addEntry(E entry)

Adds an entry to this group removing it from another group if it was part of one.

Parameters:

entry - the entry to add

Returns:

the entry added

removeEntry

E removeEntry(E entry)

Remove an entry from this group and hence from the database.

Parameters:

entry - the entry to remove

Returns:

the entry removed

Throws:

IllegalArgumentException - if the Entry is not in the group

copy

void copy(Group<? extends Database,? extends Group,? extends Entry,? extends Icon> parent)

Make a deep copy of the children a group and add to this group. Does not copy the parent group.

Parameters:

parent - the group to deep copy

getPath

String getPath()

Returns an XPath-like string of the names of Groups from the Root to this Group.

getName

String getName()

Get the name of this group

setName

void setName(String name)

Set the name of this group

getUuid

UUID getUuid()

Get the UUID of this group

getIcon

Icon getIcon()

Get the Icon of this group

setIcon

void setIcon(I icon)

Set the Icon of this group

getDatabase

@NotNull
D getDatabase()

Get the database this group was created from