de.slackspace.openkeepass.domain.zipper

Class GroupZipper

java.lang.Object

de.slackspace.openkeepass.domain.zipper.GroupZipper

public class GroupZipper
extends Object

A zipper is used to navigate through a tree structure of Group objects.

It is kind of an iterator with a pointer to the current element. The current element can be found with getNode() method.

Navigation through the tree is possible with the methods down() up() left() right().

The tree can also be modified by using the replace(Group) method to replace a node with another one.

Constructor Summary

Constructors

Constructor and Description
GroupZipper(KeePassFile keePassFile) Create a zipper with the tree structure of the given KeePass file.

Method Summary

Modifier and Type	Method and Description
boolean	canDown() Returns true if it is possible to navigate down.
boolean	canLeft() Returns true if it is possible to navigate left.
boolean	canRight() Returns true if it is possible to navigate right.
boolean	canUp() Returns true if it is possible to navigate up.
KeePassFile	cloneKeePassFile() Creates a cloned KeePassFile from the current tree structure.
KeePassFile	close() Returns a new KeePassFile from the current tree structure.
GroupZipper	down() Navigates down the tree to the first child node of the current node.
Group	getNode() Returns the current node.
Group	getRoot() Returns the root node of the tree.
Iterator<Group>	iterator() Returns an iterator over the groups in this tree.
GroupZipper	left() Navigates left the tree to the previous node at the same level.
GroupZipper	replace(Group group) Replaces the current node with the given one.
GroupZipper	replaceMeta(Meta meta) Replaces the meta with the given one.
GroupZipper	right() Navigates right the tree to the next node at the same level.
String	toString()
GroupZipper	up() Navigates up the tree to the parent node of the current node.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupZipper

public GroupZipper(KeePassFile keePassFile)

Create a zipper with the tree structure of the given KeePass file.

Parameters:

keePassFile - the underlying data structure

Method Detail

canDown

public boolean canDown()

Returns true if it is possible to navigate down.

Returns:

true, if it is possible to navigate down

down

public GroupZipper down()

Navigates down the tree to the first child node of the current node.

If the current node has no childs an exception will be thrown.

Returns:

a new groupzipper which points to the first child node of the current node

Throws:

NoSuchElementException - if the current node has no child nodes

canUp

public boolean canUp()

Returns true if it is possible to navigate up.

Returns:

true, if it is possible to navigate up

up

public GroupZipper up()

Navigates up the tree to the parent node of the current node.

If the current node has no parent an exception will be thrown.

Returns:

a new groupzipper which points to the parent node of the current node

Throws:

NoSuchElementException - if the current node has no parent node

canRight

public boolean canRight()

Returns true if it is possible to navigate right.

Returns:

true, if it is possible to navigate right

right

public GroupZipper right()

Navigates right the tree to the next node at the same level.

Returns:

a new groupzipper which points to next node at the same level

Throws:

NoSuchElementException - if the last node at the current level has already been reached

canLeft

public boolean canLeft()

Returns true if it is possible to navigate left.

Returns:

true, if it is possible to navigate left

left

public GroupZipper left()

Navigates left the tree to the previous node at the same level.

Returns:

a new groupzipper which points to the previous node at the same level

Throws:

NoSuchElementException - if the first node at the current level has already been reached

getNode

public Group getNode()

Returns the current node. This can be seen as a pointer to the current element in the tree.

Returns:

the current node

replace

public GroupZipper replace(Group group)

Replaces the current node with the given one.

Can be used to modify the tree.

Parameters:

group - the replacement node

Returns:

a new groupzipper with a replaced current node

close

public KeePassFile close()

Returns a new KeePassFile from the current tree structure.

Returns:

a new KeePass file

cloneKeePassFile

public KeePassFile cloneKeePassFile()

Creates a cloned KeePassFile from the current tree structure.

Returns:

a cloned KeePass file

getRoot

public Group getRoot()

Returns the root node of the tree.

Returns:

the root node of the tree

replaceMeta

public GroupZipper replaceMeta(Meta meta)

Replaces the meta with the given one.

Parameters:

meta - the given meta object

Returns:

a new groupzipper with replaced meta

toString

public String toString()

Overrides:

toString in class Object

iterator

public Iterator<Group> iterator()

Returns an iterator over the groups in this tree.

Returns:

an iterator to iterate through the tree