de.slackspace.openkeepass.domain

Class KeePassFile

java.lang.Object

de.slackspace.openkeepass.domain.KeePassFile

All Implemented Interfaces:

KeePassFileElement

public class KeePassFile
extends Object
implements KeePassFileElement

A KeePassFile represents the structure of a KeePass database. This is the central entry point to read data from the KeePass database.

Constructor Summary

Constructors

Constructor and Description
KeePassFile(KeePassFileBuilder builder)

Method Summary

Modifier and Type	Method and Description
List<Entry>	getEntries() Retrieves a list of all entries in the KeePass database.
List<Entry>	getEntriesByTitle(String title, boolean matchExactly) Retrieves a list of entries with matching titles.
Entry	getEntryByTitle(String title) Retrieves a single entry with an exactly matching title.
Entry	getEntryByUUID(UUID UUID) Retrieves an entry based on its UUID.
Group	getGroupByName(String name) Retrieves a single group with an exactly matching name.
List<Group>	getGroups() Retrieves a list of all groups in the KeePass database.
List<Group>	getGroupsByName(String name, boolean matchExactly) Retrieves a list of group with matching names.
Meta	getMeta() Retrieves the meta section of a KeePass database.
Group	getRoot() Retrieves the root group of a KeePass database.
List<Entry>	getTopEntries() Retrieves all entries at the root level of a KeePass database.
List<Group>	getTopGroups() Retrieves all groups at the root level of a KeePass database.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeePassFile

public KeePassFile(KeePassFileBuilder builder)

Method Detail

getMeta

public Meta getMeta()

Retrieves the meta section of a KeePass database.

Returns:

the meta section of the database

See Also:

Meta

getRoot

public Group getRoot()

Retrieves the root group of a KeePass database.

Returns:

the root group

See Also:

Group

getTopGroups

public List<Group> getTopGroups()

Retrieves all groups at the root level of a KeePass database.

Returns:

a list of root level groups

See Also:

Group

getTopEntries

public List<Entry> getTopEntries()

Retrieves all entries at the root level of a KeePass database.

Returns:

a list of root level entries

See Also:

Entry

getEntryByTitle

public Entry getEntryByTitle(String title)

Retrieves a single entry with an exactly matching title.

If there are multiple entries with the same title, the first one found will be returned.

Parameters:

title - the title which should be searched

Returns:

an entry with a matching title

See Also:

Entry

getEntriesByTitle

public List<Entry> getEntriesByTitle(String title,
                                     boolean matchExactly)

Retrieves a list of entries with matching titles.

If the matchExactly flag is true, only entries which have an exactly matching title will be returned, otherwise all entries which contain the given title will be returned.

Parameters:

title - the title which should be searched

matchExactly - if true only entries which have an exactly matching title will be returned

Returns:

a list of entries with matching titles

See Also:

Entry

getGroupsByName

public List<Group> getGroupsByName(String name,
                                   boolean matchExactly)

Retrieves a list of group with matching names.

If the matchExactly flag is true, only groups which have an exactly matching name will be returned, otherwise all groups which contain the given name will be returned.

Parameters:

name - the name which should be searched

matchExactly - if true only groups which have an exactly matching name will be returned

Returns:

a list of entries with matching names

See Also:

Group

getEntries

public List<Entry> getEntries()

Retrieves a list of all entries in the KeePass database.

Returns:

a list of all entries

See Also:

Entry

getGroups

public List<Group> getGroups()

Retrieves a list of all groups in the KeePass database.

Returns:

a list of all groups

See Also:

Group

getGroupByName

public Group getGroupByName(String name)

Retrieves a single group with an exactly matching name.

If there are multiple groups with the same name, the first one found will be returned.

Parameters:

name - the name which should be searched

Returns:

a group with a matching name

See Also:

Group

getEntryByUUID

public Entry getEntryByUUID(UUID UUID)

Retrieves an entry based on its UUID.

Parameters:

UUID - the uuid which should be searched

Returns:

the found entry or null