Helpers

java.lang.Object
- io.cryptolens.methods.Helpers

```
public class Helpers
extends java.lang.Object
```
A collection of helper methods that operate on a license key. If you are using cryptolens-android.jar, please avoid using GetMachineCode and all versions of IsOnRightMachine that do not take in a custom machine code string.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Helpers.MyClass<T>

Nested Classes
Modifier and Type	Class and Description
`class`	`Helpers.MyClass<T>`

Constructor Summary

Constructors
Constructor and Description

Helpers()

Constructors
Constructor and Description
`Helpers()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`GetMachineCode()` Returns a unique identifier of the device.
`static boolean`	`HasExpired(LicenseKey licenseKey)` Check if the current license has expired.
`static boolean`	`HasFeature(LicenseKey licenseKey, int feature)` Check if the license has a certain feature enabled (i.e.
`static boolean`	`HasFeature(LicenseKey licenseKey, java.lang.String featureName)` Uses a special data object associated with the license key to determine if a certain feature exists (instead of the 8 feature flags).
`static boolean`	`HasNotExpired(LicenseKey licenseKey)` Check if the current license has not expired.
`static boolean`	`IsOnRightMachine(LicenseKey license)` Check if the device is registered with the license key.
`static boolean`	`IsOnRightMachine(LicenseKey license, boolean isFloatingLicense)` Check if the device is registered with the license key.
`static boolean`	`IsOnRightMachine(LicenseKey license, boolean isFloatingLicense, boolean allowOverdraft)` Check if the device is registered with the license key.
`static boolean`	`IsOnRightMachine(LicenseKey license, java.lang.String machineCode)` Check if the device is registered with the license key.
`static boolean`	`IsOnRightMachine(LicenseKey license, java.lang.String machineCode, boolean isFloatingLicense)` Check if the device is registered with the license key.
`static boolean`	`IsOnRightMachine(LicenseKey license, java.lang.String machineCode, boolean isFloatingLicense, boolean allowOverdraft)` Check if the device is registered with the license key.
`static boolean`	`IsSuccessful(BasicResult result)` Checks if a response from Cryptolens is successful.

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

- Constructor Detail
  - Helpers
```
public Helpers()
```
- Method Detail
  - GetMachineCode
```
public static java.lang.String GetMachineCode()
```
    Returns a unique identifier of the device. Note, root access may be required. Note, this method is not the same as the one used in our .NET client. Also, this method only works on desktop computers.
  - IsOnRightMachine
```
public static boolean IsOnRightMachine(LicenseKey license)
```
    Check if the device is registered with the license key.
    
    Parameters:
    
    license - The license key object.
    
    Returns:
    
    True if the license is registered with this machine and False otherwise.
  - IsOnRightMachine
```
public static boolean IsOnRightMachine(LicenseKey license,
                                       boolean isFloatingLicense)
```
    Check if the device is registered with the license key.
    
    Parameters:
    
    license - The license key object.
    
    isFloatingLicense - If this is a floating license, this parameter has to be set to true. You can enable floating licenses by setting @see ActivateModel.FloatingTimeInterval.
    
    Returns:
    
    True if the license is registered with this machine and False otherwise.
  - IsOnRightMachine
```
public static boolean IsOnRightMachine(LicenseKey license,
                                       boolean isFloatingLicense,
                                       boolean allowOverdraft)
```
    Check if the device is registered with the license key.
    
    Parameters:
    
    license - The license key object
    
    isFloatingLicense - If this is a floating license, this parameter has to be set to true. You can enable floating licenses by setting @see ActivateModel.FloatingTimeInterval.
    
    allowOverdraft - If floating licensing is enabled with overdraft, this parameter should be set to true. You can enable overdraft by setting ActivateModel.MaxOverdraft" to a value greater than 0.
    
    Returns:
    
    True if the license is registered with this machine and False otherwise.
  - IsOnRightMachine
```
public static boolean IsOnRightMachine(LicenseKey license,
                                       java.lang.String machineCode)
```
    Check if the device is registered with the license key. This method is useful for platforms where the GetMachineCode() is not supported, eg. on Android.
    
    Parameters:
    
    license - The license key object.
    
    machineCode - The machine code of the current device.
    
    Returns:
    
    True if the license is registered with this machine and False otherwise.
  - IsOnRightMachine
```
public static boolean IsOnRightMachine(LicenseKey license,
                                       java.lang.String machineCode,
                                       boolean isFloatingLicense)
```
    Check if the device is registered with the license key. This method is useful for platforms where the GetMachineCode() is not supported, eg. on Android.
    
    Parameters:
    
    license - The license key object.
    
    machineCode - The machine code of the current device.
    
    isFloatingLicense - If this is a floating license, this parameter has to be set to true. You can enable floating licenses by setting @see ActivateModel.FloatingTimeInterval.
    
    Returns:
    
    True if the license is registered with this machine and False otherwise.
  - IsOnRightMachine
```
public static boolean IsOnRightMachine(LicenseKey license,
                                       java.lang.String machineCode,
                                       boolean isFloatingLicense,
                                       boolean allowOverdraft)
```
    Check if the device is registered with the license key. This method is useful for platforms where the GetMachineCode() is not supported, eg. on Android.
    
    Parameters:
    
    license - The license key object.
    
    machineCode - The machine code of the current device.
    
    isFloatingLicense - If this is a floating license, this parameter has to be set to true. You can enable floating licenses by setting @see ActivateModel.FloatingTimeInterval.
    
    allowOverdraft - If floating licensing is enabled with overdraft, this parameter should be set to true. You can enable overdraft by setting ActivateModel.MaxOverdraft" to a value greater than 0.
    
    Returns:
    
    True if the license is registered with this machine and False otherwise.
  - HasExpired
```
public static boolean HasExpired(LicenseKey licenseKey)
```
    Check if the current license has expired.
    
    Parameters:
    
    licenseKey - a license key object.
    
    Returns:
    
    True if it has expired and false otherwise.
  - HasNotExpired
```
public static boolean HasNotExpired(LicenseKey licenseKey)
```
    Check if the current license has not expired.
    
    Parameters:
    
    licenseKey - a license key object.
    
    Returns:
    
    True if it has not expired and false otherwise.
  - HasFeature
```
public static boolean HasFeature(LicenseKey licenseKey,
                                 int feature)
```
    Check if the license has a certain feature enabled (i.e. set to true).
    
    Parameters:
    
    licenseKey - a license key object.
    
    feature - The feature, eg 1 to 8.
    
    Returns:
    
    If the feature is set to true, true is returned and false otherwise.
  - HasFeature
```
public static boolean HasFeature(LicenseKey licenseKey,
                                 java.lang.String featureName)
```
    Uses a special data object associated with the license key to determine if a certain feature exists (instead of the 8 feature flags).
    
    Formatting: The name of the data object should be 'cryptolens_features' and it should be structured as a JSON array.
    
    For example,
```
["f1", "f2"]
```
    means f1 and f2 are true. You can also have feature bundling, eg.
```
["f1", ["f2",["voice","image"]]]
```
    which means that f1 and f2 are true, as well as f2.limited and f2.image. You can set any depth, eg. you can have
```
["f1", ["f2",[["voice",["all"]], "image"]]]
```
    means f2.voice.all is true as well as f2.voice and f2. The dots symbol is used to specify the "sub-features".
    Parameters:
    
    licenseKey - a license key object.
    
    featureName - the name of the feature (case-sensitive).
    
    Returns:
    
    True if the feature exists and false otherwise.
  - IsSuccessful
```
public static boolean IsSuccessful(BasicResult result)
```
    Checks if a response from Cryptolens is successful.
    
    Parameters:
    
    result - The response from an API call. All responses inherit from BasicResult.
    
    Returns:
    
    True if the response is successful and false otherwise.

Class Helpers

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Helpers

Method Detail

GetMachineCode

IsOnRightMachine

IsOnRightMachine

IsOnRightMachine

IsOnRightMachine

IsOnRightMachine

IsOnRightMachine

HasExpired

HasNotExpired

HasFeature

HasFeature

IsSuccessful