net.nicholaswilliams.java.licensing

Class License.Builder

java.lang.Object

net.nicholaswilliams.java.licensing.License.Builder

Enclosing class:

License

public static final class License.Builder
extends Object

This class is responsible for all license creation. Each method in this class returns the builder instance to make chaining possible. To create a license, simply create an instance of a builder, set any values you wish to be set on the license (or choose not to set values, as appropriate), then call build().

Constructor Summary

Constructors

Constructor and Description
License.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
License.Builder	addFeature(License.Feature feature) Adds the existing feature object to this license.
License.Builder	addFeature(String featureName) Adds a feature to this license with no expiration date.
License.Builder	addFeature(String featureName, long goodBeforeDate) Adds a feature to this license with the specified expiration date (millisecond timestamp).
License	build() Builds the license based on the criteria in this builder, then returns it.
License.Builder	withFeature(License.Feature feature) Deprecated.
License.Builder	withFeature(String featureName) Deprecated.
License.Builder	withFeature(String featureName, long goodBeforeDate) Deprecated.
License.Builder	withGoodAfterDate(long goodAfterDate) Sets the valid date (millisecond timestamp) for this license (usually the equal or close to the issue date, but that is not required.)
License.Builder	withGoodBeforeDate(long goodBeforeDate) Sets the expiration date (millisecond timestamp) for this license.
License.Builder	withHolder(String holder) Sets the holder for this license.
License.Builder	withIssueDate(long issueDate) Sets the issue date (millisecond timestamp) for this license.
License.Builder	withIssuer(String issuer) Sets the issuer for this license.
License.Builder	withNumberOfLicenses(int numberOfLicenses) Sets the number of licenses/seats/users this license is good for.
License.Builder	withProductKey(String productKey) Sets the product key for this license.
License.Builder	withSubject(String subject) Sets the subject for this license.

Methods inherited from class java.lang.Object

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

Constructor Detail

License.Builder

public License.Builder()

Method Detail

withProductKey

public License.Builder withProductKey(String productKey)

Sets the product key for this license. The productKey, issuer, holder, and subject are symbolically named; they are interchangeable and can be used to hold any number of pieces of information. For example, one might use the holder to store a hardware ID, or the subject to store a product name and version combination.

Parameters:

productKey - The product key

Returns:

the builder instance.

withIssuer

public License.Builder withIssuer(String issuer)

Sets the issuer for this license. The productKey, issuer, holder, and subject are symbolically named; they are interchangeable and can be used to hold any number of pieces of information. For example, one might use the holder to store a hardware ID, or the subject to store a product name and version combination.

Parameters:

issuer - The license issuer

Returns:

the builder instance.

withHolder

public License.Builder withHolder(String holder)

Sets the holder for this license. The productKey, issuer, holder, and subject are symbolically named; they are interchangeable and can be used to hold any number of pieces of information. For example, one might use the holder to store a hardware ID, or the subject to store a product name and version combination.

Parameters:

holder - The license holder

Returns:

the builder instance.

withSubject

public License.Builder withSubject(String subject)

Sets the subject for this license. The productKey, issuer, holder, and subject are symbolically named; they are interchangeable and can be used to hold any number of pieces of information. For example, one might use the holder to store a hardware ID, or the subject to store a product name and version combination.

Parameters:

subject - The license subject

Returns:

the builder instance.

withIssueDate

public License.Builder withIssueDate(long issueDate)

Sets the issue date (millisecond timestamp) for this license.

Parameters:

issueDate - The date this license was issued

Returns:

the builder instance.

withGoodAfterDate

public License.Builder withGoodAfterDate(long goodAfterDate)

Sets the valid date (millisecond timestamp) for this license (usually the equal or close to the issue date, but that is not required.)

Parameters:

goodAfterDate - The date after which this license is valid

Returns:

the builder instance.

withGoodBeforeDate

public License.Builder withGoodBeforeDate(long goodBeforeDate)

Sets the expiration date (millisecond timestamp) for this license.

Parameters:

goodBeforeDate - The date after which this license is no longer valid

Returns:

the builder instance.

withNumberOfLicenses

public License.Builder withNumberOfLicenses(int numberOfLicenses)

Sets the number of licenses/seats/users this license is good for.

Parameters:

numberOfLicenses - The number of licenses this license is good for

Returns:

the builder instance.

addFeature

public License.Builder addFeature(String featureName)

Adds a feature to this license with no expiration date.

Parameters:

featureName - The feature to add to this license

Returns:

the builder instance.

withFeature

@Deprecated
public License.Builder withFeature(String featureName)

Deprecated.

addFeature

public License.Builder addFeature(String featureName,
                         long goodBeforeDate)

Adds a feature to this license with the specified expiration date (millisecond timestamp).

Parameters:

featureName - The feature to add to this license

goodBeforeDate - The expiration date for this license

Returns:

the builder instance.

withFeature

@Deprecated
public License.Builder withFeature(String featureName,
                                     long goodBeforeDate)

Deprecated.

addFeature

public License.Builder addFeature(License.Feature feature)

Adds the existing feature object to this license.

Parameters:

feature - The feature object to add to this license

Returns:

the builder instance.

withFeature

@Deprecated
public License.Builder withFeature(License.Feature feature)

Deprecated.

build

public License build()

Builds the license based on the criteria in this builder, then returns it.

Returns:

the completed license with all of the content specified by this builder.