Package com.chemaxon.apidiscovery

Class InstanceWrapper<T>

java.lang.Object
com.chemaxon.apidiscovery.InstanceWrapper<T>
Type Parameters:
T - Type of wrapped instance
@Beta @PublicAPI @Deprecated(forRemoval=true) @SubjectToRemoval(date=JAN_01_2025) public class InstanceWrapper<T> extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
The API discovery tool will be removed.
Wrapper for Instances.

Note that usually instances actual are immutable (because of being parameter objects or enums). Some of them have associated builder classes.

Please note that this class is marked with @Beta annotation, so it can be subject of incompatible changes or removal in later releases.

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    get()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get the actual wrapped instance.
    Optional<ParameterBuilder<T>>
    getBuilder()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get an associated builder for the given instance if exists.
    String
    getDescription()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Represented instance description - from its description annotation.
    String
    getName()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Represented instance name - from its Description annotation.
    String
    getShortName()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Represented instance short name - from its Description annotation.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • get

      public T get()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get the actual wrapped instance.

      Please note that instance might be immutable, in this case associated builder should be used.

      Returns:
      Wrapped instance

    • getBuilder

      public Optional<ParameterBuilder<T>> getBuilder()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get an associated builder for the given instance if exists.
      Returns:
      associated builder

    • getShortName

      public String getShortName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Represented instance short name - from its Description annotation.
      Returns:
      Short name

    • getName

      public String getName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Represented instance name - from its Description annotation.
      Returns:
      Name

    • getDescription

      public String getDescription()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Represented instance description - from its description annotation.
      Returns:
      Description of the represented instance