Open topic with navigation

com.hp.lft.sdk

## Class DescriptionBase.Init<T extends DescriptionBase.Init<T>>

- java.lang.Object
- - com.hp.lft.sdk.DescriptionBase.Init<T>

- Direct Known Subclasses:
    DescriptionBase.Builder, ElementDescription.Init, FieldDescription.Init, GuiSessionDescription.Init, PageDescription.Init, ScreenDescription.Init, UiObjectBaseDescription.Init, UiObjectBaseDescription.Init, UiObjectDescriptionBase.Init, UiObjectDescriptionBase.Init, WebBaseDescription.Init, WindowDescription.Init
  Enclosing class:
    DescriptionBase

      protected abstract static class DescriptionBase.Init<T extends DescriptionBase.Init<T>>
      extends java.lang.Object

  Helper class for DescriptionBase.Builder.

- - ### Constructor Summary

    Modifier | Constructor and Description
    --- | ---
    `protected` | `Init()`

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `DescriptionBase` | `build()` Returns the built description instance (builder pattern).
    `T` | `index(java.lang.Integer index)` Initializes the index of this object.
    `protected abstract T` | `self()`
    `T` | `vri(java.util.List<VisualRelation> visualRelations)` Initializes a VisualRelation definition.
    `T` | `vri(VisualRelation... visualRelations)` Initializes a VisualRelation definition.

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### Init

          protected Init()

  - ### Method Detail

    - #### self

          protected abstract T self()

    - #### index

          public T index(java.lang.Integer index)

      Initializes the index of this object.
      The index helps to distinguish the object, based on its order of appearance in the application screen relative to all other objects with an otherwise identical description.
      Parameters:
        `index` - the index of the object.
      Returns:
        the description instance with the update state (builder pattern).

    - #### vri

          public T vri(java.util.List<VisualRelation> visualRelations)

      Initializes a VisualRelation definition.
      The VRI definition helps to distinguish this object from other objects with otherwise identical descriptions, based on this object's visual relationship to another object in the application.
      Parameters:
        `visualRelations` - the `VisualRelation` object containing the VRI definition for this object.
      Returns:
        the description instance with the updated state (builder pattern).

    - #### vri

          public T vri(VisualRelation... visualRelations)

      Initializes a VisualRelation definition.
      The VRI definition helps to distinguish this object from other objects with otherwise identical descriptions, based on this object's visual relationship to another object in the application.
      Parameters:
        `visualRelations` - the `VisualRelation` object containing the VRI definition for this object.
      Returns:
        the description instance with the updated state (builder pattern).

    - #### build

          public DescriptionBase build()

      Returns the built description instance (builder pattern).
      Returns:
        The built description instance (builder pattern).