WriteableBeanDatabaseImpl (HK2 API Documentation)

java.lang.Object
- org.glassfish.hk2.configuration.hub.internal.WriteableBeanDatabaseImpl

All Implemented Interfaces:: BeanDatabase, WriteableBeanDatabase

public class WriteableBeanDatabaseImpl
extends Object
implements WriteableBeanDatabase

Author:: jwells

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WriteableType`	`addType(String typeName)` Adds a type of the given name
`void`	`commit()` This method should be called when the writeable database should become the current database.
`void`	`commit(Object commitMessage)` This method should be called when the writeable database should become the current database.
`void`	`dumpDatabase()` Dumps the type and instance names to stderr
`void`	`dumpDatabase(PrintStream output)` Dumps the type and instance names to the given stream
`String`	`dumpDatabaseAsString()` Dumps the type and instance names to a String for debugging
`WriteableType`	`findOrAddWriteableType(String typeName)` Gets or creates a writeable type with the given name
`Set<Type>`	`getAllTypes()` Gets an unmodifiable set of all the types in the bean database
`Set<WriteableType>`	`getAllWriteableTypes()` Gets an unmodifiable set of all the types in the bean database
`Object`	`getCommitMessage()` Gets the commit message for this writeable bean database
`Instance`	`getInstance(String type, String instanceKey)` Returns the instance with the given instanceKey from the type with the given name
`TwoPhaseResource`	`getTwoPhaseResource()` Returns a two-phase resource that can be used by a DynamicConfiguration to tie the transaction done by this WriteableBeanDatabase into a commit done by the DynamicConfiguration.
`Type`	`getType(String type)` Gets the type with the given name
`WriteableType`	`getWriteableType(String typeName)` Gets a writeable type of the given name
`Type`	`removeType(String typeName)` Removed the given type and all of its instances from the database.
`void`	`setCommitMessage(Object commitMessage)` Sets the commit message for this writeable bean database
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getAllTypes
```
public Set<Type> getAllTypes()
```
    Description copied from interface: BeanDatabase
    
    Gets an unmodifiable set of all the types in the bean database
    
    Specified by:
    
    getAllTypes in interface BeanDatabase
    
    Returns:
    
    A non-null unmodifiable and possibly empty set of all the types in the database
  - getAllWriteableTypes
```
public Set<WriteableType> getAllWriteableTypes()
```
    Description copied from interface: WriteableBeanDatabase
    
    Gets an unmodifiable set of all the types in the bean database
    
    Specified by:
    
    getAllWriteableTypes in interface WriteableBeanDatabase
    
    Returns:
    
    A non-null unmodifiable and possibly empty set of all the types in the database
  - getType
```
public Type getType(String type)
```
    Description copied from interface: BeanDatabase
    
    Gets the type with the given name
    
    Specified by:
    
    getType in interface BeanDatabase
    
    Parameters:
    
    type - The non-null name
    
    Returns:
    
    The type corresponding to the given name. May return null
  - getInstance
```
public Instance getInstance(String type,
                            String instanceKey)
```
    Description copied from interface: BeanDatabase
    
    Returns the instance with the given instanceKey from the type with the given name
    
    Specified by:
    
    getInstance in interface BeanDatabase
    
    Parameters:
    
    type - The non-null name of the type to get the instance from
    
    instanceKey - The non-null key of the instance
    
    Returns:
    
    The bean from the given type with the given name. Will return null if the type does not exist or an instance with that key does not exist
  - addType
```
public WriteableType addType(String typeName)
```
    Description copied from interface: WriteableBeanDatabase
    
    Adds a type of the given name
    
    Specified by:
    
    addType in interface WriteableBeanDatabase
    
    Parameters:
    
    typeName - The name of the type to add
    
    Returns:
    
    The non-null type that has been added to the database
  - removeType
```
public Type removeType(String typeName)
```
    Description copied from interface: WriteableBeanDatabase
    
    Removed the given type and all of its instances from the database. The set of changes will include the instances removed prior to the change indicating that the type was removed
    
    Specified by:
    
    removeType in interface WriteableBeanDatabase
    
    Parameters:
    
    typeName - The non-null type name
    
    Returns:
    
    The type that was removed
  - getWriteableType
```
public WriteableType getWriteableType(String typeName)
```
    Description copied from interface: WriteableBeanDatabase
    
    Gets a writeable type of the given name
    
    Specified by:
    
    getWriteableType in interface WriteableBeanDatabase
    
    Parameters:
    
    typeName - The non-null name of the type to fetch
    
    Returns:
    
    The existing type, or null if the type does not already exist
  - findOrAddWriteableType
```
public WriteableType findOrAddWriteableType(String typeName)
```
    Description copied from interface: WriteableBeanDatabase
    
    Gets or creates a writeable type with the given name
    
    Specified by:
    
    findOrAddWriteableType in interface WriteableBeanDatabase
    
    Parameters:
    
    typeName - The non-null name of the type to find or create
    
    Returns:
    
    The non-null writeable type that was created or found
  - commit
```
public void commit()
```
    Description copied from interface: WriteableBeanDatabase
    
    This method should be called when the writeable database should become the current database. All changes will be communicated to the listeners. If the current database has been modified since this writeable database was created then this method will throw an IllegalStateException. This version of commit will use the commit message set on this writeable bean database
    
    Specified by:
    
    commit in interface WriteableBeanDatabase
  - commit
```
public void commit(Object commitMessage)
```
    Description copied from interface: WriteableBeanDatabase
    
    This method should be called when the writeable database should become the current database. All changes will be communicated to the listeners. If the current database has been modified since this writeable database was created then this method will throw an IllegalStateException. This version of commit will use the commit message passed in rather than the one set on this writeable bean database
    
    Specified by:
    
    commit in interface WriteableBeanDatabase
    
    Parameters:
    
    commitMessage - An object to pass to any BeanDatabaseUpdateListener that is registered
  - dumpDatabase
```
public void dumpDatabase()
```
    Description copied from interface: BeanDatabase
    
    Dumps the type and instance names to stderr
    
    Specified by:
    
    dumpDatabase in interface BeanDatabase
  - dumpDatabase
```
public void dumpDatabase(PrintStream output)
```
    Description copied from interface: BeanDatabase
    
    Dumps the type and instance names to the given stream
    
    Specified by:
    
    dumpDatabase in interface BeanDatabase
    
    Parameters:
    
    output - - The non-null outut stream to write the database to
  - dumpDatabaseAsString
```
public String dumpDatabaseAsString()
```
    Description copied from interface: BeanDatabase
    
    Dumps the type and instance names to a String for debugging
    
    Specified by:
    
    dumpDatabaseAsString in interface BeanDatabase
    
    Returns:
    
    A string with all type and instance names
  - getTwoPhaseResource
```
public TwoPhaseResource getTwoPhaseResource()
```
    Description copied from interface: WriteableBeanDatabase
    
    Returns a two-phase resource that can be used by a DynamicConfiguration to tie the transaction done by this WriteableBeanDatabase into a commit done by the DynamicConfiguration. When the DynamicConfiguration calls commit this WriteableBeanDatabase will be part of the transaction
    
    Specified by:
    
    getTwoPhaseResource in interface WriteableBeanDatabase
    
    Returns:
    
    A non-null TwoPhaseResource to be used by a DynamicConfiguration
  - getCommitMessage
```
public Object getCommitMessage()
```
    Description copied from interface: WriteableBeanDatabase
    
    Gets the commit message for this writeable bean database
    
    Specified by:
    
    getCommitMessage in interface WriteableBeanDatabase
    
    Returns:
    
    The possibly null commit message for this writeable bean database
  - setCommitMessage
```
public void setCommitMessage(Object commitMessage)
```
    Description copied from interface: WriteableBeanDatabase
    
    Sets the commit message for this writeable bean database
    
    Specified by:
    
    setCommitMessage in interface WriteableBeanDatabase
    
    Parameters:
    
    commitMessage - The possibly null commit message for this writeable bean database
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class WriteableBeanDatabaseImpl

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getAllTypes

getAllWriteableTypes

getType

getInstance

addType

removeType

getWriteableType

findOrAddWriteableType

commit

commit

dumpDatabase

dumpDatabase

dumpDatabaseAsString

getTwoPhaseResource

getCommitMessage

setCommitMessage

toString