Package org.gorpipe.querydialogs

Class ArgumentDescription

java.lang.Object
org.gorpipe.querydialogs.ArgumentDescription
public class ArgumentDescription
extends java.lang.Object
Argument description class.

  • Field Summary

    Fields 
    Modifier and Type Field Description
    java.lang.String displayName  
    java.lang.String name  
    java.lang.String shortDescr  
    java.lang.String tooltip  

  • Constructor Summary

    Constructors 
    Constructor Description
    ArgumentDescription​(java.lang.String name, java.lang.String shortDescr, java.lang.String displayName, java.lang.String tooltip)  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getDisplayName()
    Get the display name.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • name

      public final java.lang.String name

    • shortDescr

      public final java.lang.String shortDescr

    • tooltip

      public final java.lang.String tooltip

    • displayName

      public final java.lang.String displayName

  • Constructor Details

    • ArgumentDescription

      public ArgumentDescription​(java.lang.String name, java.lang.String shortDescr, java.lang.String displayName, java.lang.String tooltip)
      Parameters:
      name - argument name
      shortDescr - short description
      displayName - the display name
      tooltip - the tooltip

  • Method Details

    • getDisplayName

      public java.lang.String getDisplayName()
      Get the display name. If display name is not defined then name is used instead.
      Returns:
      the display name