Package com.github.tadukoo.database.mysql.pojo

Class SubPojoDefinition.SubPojoDefinitionBuilder

java.lang.Object

com.github.tadukoo.database.mysql.pojo.SubPojoDefinition.SubPojoDefinitionBuilder

All Implemented Interfaces:

SubPojoDefinition.Build, SubPojoDefinition.IDColumn, SubPojoDefinition.Key, SubPojoDefinition.TypeAndJunction

Enclosing class:

SubPojoDefinition

public static class SubPojoDefinition.SubPojoDefinitionBuilder
extends Object
implements SubPojoDefinition.Key, SubPojoDefinition.IDColumn, SubPojoDefinition.TypeAndJunction, SubPojoDefinition.Build

A builder used to build a SubPojoDefinition. It takes the following parameters:

Sub Pojo Definition Parameters

Parameter	Description	Default or Required
key	The key the sub pojo is stored using in the pojo	Required
idCol	The ID column for the sub pojo's ID stored in the pojo	Required if type or junction is specified, otherwise defaults to null
type	The class used for the sub pojo, in case the pojo has to create a new instance of it	Required if junction is specified, otherwise defaults to null
junction	The junction to use for this sub pojo when doing a search on the pojo	Required if type is specified, otherwise defaults to null

Version:

Alpha v.0.3

Author:

Logan Ferree (Tadukoo)

Field Summary

Fields

Modifier and Type	Field	Description
private String	idCol	The ID column for the sub pojo's ID stored in the pojo
private com.github.tadukoo.util.tuple.Pair<ColumnRef,ColumnRef>	junction	The junction to use for this sub pojo when doing a search on the pojo
private String	key	The key the sub pojo is stored using in the pojo
private Class<? extends DatabasePojo>	type	The class used for the sub pojo, in case the pojo has to create a new instance of it

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SubPojoDefinitionBuilder()	Not allowed to instantiate outside SubPojoDefinition

Method Summary

Modifier and Type	Method	Description
SubPojoDefinition	build()	Builds a new SubPojoDefinition using the set parameters after checking for problems
private void	checkForErrors()	Checks for any errors in the set parameters and throws an error if any problems are found
SubPojoDefinition.TypeAndJunction	idCol(String idCol)
SubPojoDefinition.IDColumn	key(String key)
SubPojoDefinition.Build	typeAndJunction(Class<? extends DatabasePojo> type, com.github.tadukoo.util.tuple.Pair<ColumnRef,ColumnRef> junction)

Methods inherited from class java.lang.Object

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

Field Details

key

private String key

The key the sub pojo is stored using in the pojo

idCol

private String idCol

The ID column for the sub pojo's ID stored in the pojo

type

private Class<? extends DatabasePojo> type

The class used for the sub pojo, in case the pojo has to create a new instance of it

junction

private com.github.tadukoo.util.tuple.Pair<ColumnRef,ColumnRef> junction

The junction to use for this sub pojo when doing a search on the pojo

Constructor Details

SubPojoDefinitionBuilder

private SubPojoDefinitionBuilder()

Not allowed to instantiate outside SubPojoDefinition

Method Details

key

public SubPojoDefinition.IDColumn key(String key)

Specified by:

key in interface SubPojoDefinition.Key

Parameters:

key - The key the sub pojo is stored using in the pojo

Returns:

this, to continue building

idCol

public SubPojoDefinition.TypeAndJunction idCol(String idCol)

Specified by:

idCol in interface SubPojoDefinition.IDColumn

Parameters:

idCol - The ID column for the sub pojo's ID stored in the pojo

Returns:

this, to continue building

typeAndJunction

public SubPojoDefinition.Build typeAndJunction(Class<? extends DatabasePojo> type,
 com.github.tadukoo.util.tuple.Pair<ColumnRef,ColumnRef> junction)

Specified by:

typeAndJunction in interface SubPojoDefinition.TypeAndJunction

Parameters:

type - The class used for the sub pojo, in case the pojo has to create a new instance of it

junction - The junction to use for this sub pojo when doing a search on the pojo

Returns:

this, to continue building

checkForErrors

private void checkForErrors()

Checks for any errors in the set parameters and throws an error if any problems are found

build

public SubPojoDefinition build()

Builds a new SubPojoDefinition using the set parameters after checking for problems

Specified by:

build in interface SubPojoDefinition.Build

Returns:

The newly built SubPojoDefinition