Package com.pnfsoftware.jeb.core.actions

Class ActionXrefsData

java.lang.Object
com.pnfsoftware.jeb.core.actions.ActionData
com.pnfsoftware.jeb.core.actions.ActionXrefsData
All Implemented Interfaces:
IActionData
public class ActionXrefsData extends ActionData
Action payload for Actions.QUERY_XREFS.

  • Constructor Details

    • ActionXrefsData

      public ActionXrefsData()

  • Method Details

    • setHintMaxResults

      public void setHintMaxResults(int hintMaxResults)
      Set an optional cap for the number of references that the plugin should return. This method is used by clients.
      Parameters:
      hintMaxResults - hint, may be set to 0 or negative to mean that no-cap

    • getHintMaxResults

      public int getHintMaxResults()
      Retrieve the optional cap for the number of references that the plugin should return. This method is used by plugins.
      Returns:
      cap hint, may be set to 0 or negative to mean that no-cap

    • getTarget

      public String getTarget()
      Get the effective target for the xref query.
      Returns:
      the target address or signature, or null if it must be inferred by the plugin

    • setTarget

      public void setTarget(String target)
      Can be used by the client or plugin. If the client leaves it to null, it is up to the plugin to determine the wanted target address, and fill up this field. If the client provides it, the plugin must use it.
      Parameters:
      target - target address or signature

    • getAddresses

      public List<String> getAddresses()
      Get the list of addresses. This method is used by clients.
      Returns:
      a list of addresses

    • setAddresses

      public void setAddresses(List<String> addresses)
      Set the list of addresses. This method is used by plugins.
      Parameters:
      addresses - list of addresses

    • getDetails

      public List<String> getDetails()
      Get a list of optional details, associated to the list of returned addresses. This method is used by clients. If non-null, must contain the same number of entries as getAddresses().
      Returns:
      if non-null, the length must be the same as the list of addresses; the individual elements may be null

    • setDetails

      public void setDetails(List<String> details)
      Set the list of detail strings. This method is used by plugins.
      Parameters:
      details - detail strings aligned with getAddresses()

    • getUserAddresses

      public List<String> getUserAddresses()
      Get a list of optional details, associated to the list of returned addresses. This method is used by clients. If non-null, must contain the same number of entries as getAddresses().
      Returns:
      an optional list of user addresses

    • setUserAddresses

      public void setUserAddresses(List<String> userAddresses)
      Set the list of user-friendly addresses. This method is used by plugins.
      Parameters:
      userAddresses - user-friendly addresses aligned with getAddresses()