Package com.github.tadukoo.java.packagedeclaration

Class JavaPackageDeclarationBuilder<PackageDeclaration extends JavaPackageDeclaration>

java.lang.Object

com.github.tadukoo.java.packagedeclaration.JavaPackageDeclarationBuilder<PackageDeclaration>

Type Parameters:

PackageDeclaration - The type of JavaPackageDeclaration that will be returned by the builder

Direct Known Subclasses:

EditableJavaPackageDeclaration.EditableJavaPackageDeclarationBuilder, UneditableJavaPackageDeclaration.UneditableJavaPackageDeclarationBuilder

public abstract class JavaPackageDeclarationBuilder<PackageDeclaration extends JavaPackageDeclaration>
extends Object

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

Java Package Declaration Parameters

Parameter Name	Description	Default or Required
packageName	The name of the package in the declaration	Required

Version:

Beta v.0.5

Author:

Logan Ferree (Tadukoo)

Field Summary

Fields

Modifier and Type	Field	Description
protected String	packageName	The name of the package in the declaration

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JavaPackageDeclarationBuilder()	Not allowed to instantiate outside of subclasses

Method Summary

Modifier and Type	Method	Description
PackageDeclaration	build()	Builds a new package declaration using the set parameters, after checking for errors
protected abstract PackageDeclaration	constructPackageDeclaration()
JavaPackageDeclarationBuilder<PackageDeclaration>	copy(JavaPackageDeclaration packageDeclaration)	Copies the settings from the given package declaration to this builder
JavaPackageDeclarationBuilder<PackageDeclaration>	packageName(String packageName)

Methods inherited from class java.lang.Object

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

Field Details

packageName

protected String packageName

The name of the package in the declaration

Constructor Details

JavaPackageDeclarationBuilder

protected JavaPackageDeclarationBuilder()

Not allowed to instantiate outside of subclasses

Method Details

copy

public JavaPackageDeclarationBuilder<PackageDeclaration> copy(JavaPackageDeclaration packageDeclaration)

Copies the settings from the given package declaration to this builder

Parameters:

packageDeclaration - The package declaration to copy settings from

Returns:

this, to continue building

packageName

public JavaPackageDeclarationBuilder<PackageDeclaration> packageName(String packageName)

Parameters:

packageName - The name of the package in the declaration

Returns:

this, to continue building

build

public PackageDeclaration build()

Builds a new package declaration using the set parameters, after checking for errors

Returns:

The newly built package declaration

constructPackageDeclaration

protected abstract PackageDeclaration constructPackageDeclaration()

Returns:

A newly constructed package declaration