License (LicenseManager - Core 1.1.0 API Documentation)

java.lang.Object
- net.nicholaswilliams.java.licensing.License

All Implemented Interfaces:

Serializable, Cloneable
```
public final class License
extends Object
implements Serializable, Cloneable
```
This is the license object, which is serialized and signed to a file for use by the application later. All the object fields are immutable and final so as to prevent modification by reflection.

This object is not created directly. For instructions on creating licenses, see the documentation for License.Builder.

Since:

1.0.0

Version:

1.7.0

Author:

Nick Williams

See Also:
License.Builder, License.Feature, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`License.Builder` This class is responsible for all license creation.
`static class`	`License.Feature` A class that represents a licensed feature.

Method Summary

Methods
Modifier and Type	Method and Description
`License`	`clone()` Performs a deep clone of this license and its content and features.
`protected static License`	`deserialize(byte[] data)` Deserializes a serialized license into an actual License object.
`boolean`	`equals(Object object)` Checks whether the provided license object is identical to this one in content, features and expiration dates, deeply.
`ImmutableLinkedHashSet<License.Feature>`	`getFeatures()` Returns an immutable (unchangeable) list of all of the features contained within this license.
`long`	`getGoodAfterDate()` Returns the millisecond timestamp for the date after which this license is valid (usually equal or close to the issue date, but this is not required.)
`long`	`getGoodBeforeDate()` Returns the millisecond timestamp for the date before which this license is valid (i.e., the expiration date).
`String`	`getHolder()` Returns the holder of this license.
`long`	`getIssueDate()` Returns the millisecond timestamp for the issue date of this license.
`String`	`getIssuer()` Returns the issuer of this license.
`int`	`getNumberOfLicenses()` Returns the number of licenses/seats/users that this license is valid for.
`String`	`getProductKey()` Returns the product key for this license.
`String`	`getSubject()` Returns the subject for this license.
`int`	`hashCode()` Calculates a hash code for this license.
`boolean`	`hasLicenseForAllFeatures(FeatureObject... features)` Checks if all of the features specified are licensed in this license.
`boolean`	`hasLicenseForAllFeatures(long currentDate, FeatureObject... features)` Checks if all of the features specified are licensed in this license.
`boolean`	`hasLicenseForAllFeatures(long currentDate, String... featureNames)` Checks if all of the features specified are licensed in this license.
`boolean`	`hasLicenseForAllFeatures(String... featureNames)` Checks if all of the features specified are licensed in this license.
`boolean`	`hasLicenseForAnyFeature(FeatureObject... features)` Checks if all of the features specified are licensed in this license.
`boolean`	`hasLicenseForAnyFeature(long currentDate, FeatureObject... features)` Checks if all of the features specified are licensed in this license.
`boolean`	`hasLicenseForAnyFeature(long currentDate, String... featureNames)` Checks if all of the features specified are licensed in this license.
`boolean`	`hasLicenseForAnyFeature(String... featureNames)` Checks if all of the features specified are licensed in this license.
`boolean`	`hasLicenseForFeature(FeatureObject feature)` Checks if the feature specified is licensed.
`boolean`	`hasLicenseForFeature(long currentDate, FeatureObject feature)` Checks if the feature specified is licensed.
`boolean`	`hasLicenseForFeature(long currentDate, String featureName)` Checks if the feature specified is licensed.
`boolean`	`hasLicenseForFeature(String featureName)` Checks if the feature specified is licensed.
`byte[]`	`serialize()` Serialized this license into a byte array that can be shipped electronically.
`String`	`toString()` Generates a string representation of this license.

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

- Method Detail
  - serialize
```
public byte[] serialize()
```
    Serialized this license into a byte array that can be shipped electronically.
    
    Returns:
    a serialized form of this license.
  - deserialize
```
protected static License deserialize(byte[] data)
```
    Deserializes a serialized license into an actual License object.
    
    Parameters:
    data - The serialized data to create the license from
    
    Returns:
    the unserialized license.
  - getProductKey
```
public final String getProductKey()
```
    Returns 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.
    
    Returns:
    the product key.
  - getIssuer
```
public final String getIssuer()
```
    Returns the issuer of 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.
    
    Returns:
    the license issuer.
  - getHolder
```
public final String getHolder()
```
    Returns the holder of 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.
    
    Returns:
    the license holder.
  - getSubject
```
public final String getSubject()
```
    Returns 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.
    
    Returns:
    the license subject.
  - getIssueDate
```
public final long getIssueDate()
```
    Returns the millisecond timestamp for the issue date of this license.
    
    Returns:
    the date this license was issued.
  - getGoodAfterDate
```
public final long getGoodAfterDate()
```
    Returns the millisecond timestamp for the date after which this license is valid (usually equal or close to the issue date, but this is not required.)
    
    Returns:
    the date after which this license is valid.
  - getGoodBeforeDate
```
public final long getGoodBeforeDate()
```
    Returns the millisecond timestamp for the date before which this license is valid (i.e., the expiration date).
    
    Returns:
    the date before which this license is valid (and after which it has expired).
  - getNumberOfLicenses
```
public final int getNumberOfLicenses()
```
    Returns the number of licenses/seats/users that this license is valid for.
    
    Returns:
    the number of licenses this represents.
  - getFeatures
```
public final ImmutableLinkedHashSet<License.Feature> getFeatures()
```
    Returns an immutable (unchangeable) list of all of the features contained within this license. For more information on features see License.Feature and License.Builder.
    
    Returns:
    a list of all of the licensed features.
    See Also:
    License.Feature
  - hasLicenseForFeature
```
public final boolean hasLicenseForFeature(String featureName)
```
    Checks if the feature specified is licensed. If the feature is licensed and has an expiration, ensures that the feature is not expired based on the current date before returning true.
    
    Parameters:
    featureName - The feature to check
    
    Returns:
    true if this feature is licensed and valid, false otherwise.
  - hasLicenseForFeature
```
public final boolean hasLicenseForFeature(long currentDate,
                           String featureName)
```
    Checks if the feature specified is licensed. If the feature is licensed and has an expiration, ensures that the feature is not expired based on the provided date before returning true.
    
    Parameters:
    currentDate - The date (millisecond timestamp) to check the feature against
    featureName - The feature to check
    
    Returns:
    true if this feature is licensed and valid, false otherwise.
  - hasLicenseForFeature
```
public final boolean hasLicenseForFeature(FeatureObject feature)
```
    Checks if the feature specified is licensed. If the feature is licensed and has an expiration, ensures that the feature is not expired based on the current date before returning true.
    
    Parameters:
    feature - The feature to check
    
    Returns:
    true if this feature is licensed and valid, false otherwise.
  - hasLicenseForFeature
```
public final boolean hasLicenseForFeature(long currentDate,
                           FeatureObject feature)
```
    Checks if the feature specified is licensed. If the feature is licensed and has an expiration, ensures that the feature is not expired based on the provided date before returning true.
    
    Parameters:
    currentDate - The date (millisecond timestamp) to check the feature against
    feature - The feature to check
    
    Returns:
    true if this feature is licensed and valid, false otherwise.
  - hasLicenseForAnyFeature
```
public final boolean hasLicenseForAnyFeature(String... featureNames)
```
    Checks if all of the features specified are licensed in this license. If any one feature is licensed, this method returns true. Any features that contain expiration dates are checked against the current date. Features are only valid if they have no expiration date or they are not expired.
    
    Parameters:
    featureNames - The features to check
    
    Returns:
    true if any one feature listed is licensed and valid, false otherwise.
  - hasLicenseForAnyFeature
```
public final boolean hasLicenseForAnyFeature(long currentDate,
                              String... featureNames)
```
    Checks if all of the features specified are licensed in this license. If any one feature is licensed, this method returns true. Any features that contain expiration dates are checked against the current date. Features are only valid if they have no expiration date or they are not expired.
    
    Parameters:
    currentDate - The date (millisecond timestamp) to check features against
    featureNames - The features to check
    
    Returns:
    true if any one feature listed is licensed and valid, false otherwise.
  - hasLicenseForAnyFeature
```
public final boolean hasLicenseForAnyFeature(FeatureObject... features)
```
    Checks if all of the features specified are licensed in this license. If any one feature is licensed, this method returns true. Any features that contain expiration dates are checked against the current date. Features are only valid if they have no expiration date or they are not expired.
    
    Parameters:
    features - The features to check
    
    Returns:
    true if any one feature listed is licensed and valid, false otherwise.
  - hasLicenseForAnyFeature
```
public final boolean hasLicenseForAnyFeature(long currentDate,
                              FeatureObject... features)
```
    Checks if all of the features specified are licensed in this license. If any one feature is licensed, this method returns true. Any features that contain expiration dates are checked against the current date. Features are only valid if they have no expiration date or they are not expired.
    
    Parameters:
    currentDate - The date (millisecond timestamp) to check features against
    features - The features to check
    
    Returns:
    true if any one feature listed is licensed and valid, false otherwise.
  - hasLicenseForAllFeatures
```
public final boolean hasLicenseForAllFeatures(String... featureNames)
```
    Checks if all of the features specified are licensed in this license. If any one feature isn't licensed, this method returns false. Any features that contain expiration dates are checked against the current date. If any one feature is expired, this method returns false.
    
    Parameters:
    featureNames - The features to check
    
    Returns:
    true if every feature listed is licensed and valid, false otherwise.
  - hasLicenseForAllFeatures
```
public final boolean hasLicenseForAllFeatures(long currentDate,
                               String... featureNames)
```
    Checks if all of the features specified are licensed in this license. If any one feature isn't licensed, this method returns false. Any features that contain expiration dates are checked against the provided date. If any one feature is expired, this method returns false.
    
    Parameters:
    currentDate - The date (millisecond timestamp) to check features against
    featureNames - The features to check
    
    Returns:
    true if every feature listed is licensed and valid, false otherwise.
  - hasLicenseForAllFeatures
```
public final boolean hasLicenseForAllFeatures(FeatureObject... features)
```
    Checks if all of the features specified are licensed in this license. If any one feature isn't licensed, this method returns false. Any features that contain expiration dates are checked against the current date. If any one feature is expired, this method returns false.
    
    Parameters:
    features - The features to check
    
    Returns:
    true if every feature listed is licensed and valid, false otherwise.
  - hasLicenseForAllFeatures
```
public final boolean hasLicenseForAllFeatures(long currentDate,
                               FeatureObject... features)
```
    Checks if all of the features specified are licensed in this license. If any one feature isn't licensed, this method returns false. Any features that contain expiration dates are checked against the provided date. If any one feature is expired, this method returns false.
    
    Parameters:
    currentDate - The date (millisecond timestamp) to check features against
    features - The features to check
    
    Returns:
    true if every feature listed is licensed and valid, false otherwise.
  - equals
```
public final boolean equals(Object object)
```
    Checks whether the provided license object is identical to this one in content, features and expiration dates, deeply.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    object - The license to check for equality against
    
    Returns:
    true if the licenses are identical, false otherwise.
  - hashCode
```
public final int hashCode()
```
    Calculates a hash code for this license.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    a hash code for this license.
  - toString
```
public final String toString()
```
    Generates a string representation of this license.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    the string representation of this license.
  - clone
```
public final License clone()
```
    Performs a deep clone of this license and its content and features.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    a deep clone of this license.

Class License

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

serialize

deserialize

getProductKey

getIssuer

getHolder

getSubject

getIssueDate

getGoodAfterDate

getGoodBeforeDate

getNumberOfLicenses

getFeatures

hasLicenseForFeature

hasLicenseForFeature

hasLicenseForFeature

hasLicenseForFeature

hasLicenseForAnyFeature

hasLicenseForAnyFeature

hasLicenseForAnyFeature

hasLicenseForAnyFeature

hasLicenseForAllFeatures

hasLicenseForAllFeatures

hasLicenseForAllFeatures

hasLicenseForAllFeatures

equals

hashCode

toString

clone