Package com.perforce.p4java.server.delegator

Interface IKeyDelegator

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String deleteKey​(java.lang.String keyName)
      Delete a key on a Perforce server.
      java.lang.String getKey​(java.lang.String keyName)
      Get the value of a named Perforce key from the Perforce server.
      java.lang.String setKey​(java.lang.String keyName, java.lang.String value, KeyOptions opts)
      Create, set or delete a key on a Perforce server.

    • Method Detail

      • deleteKey

        java.lang.String deleteKey​(java.lang.String keyName)
                    throws P4JavaException
        Delete a key on a Perforce server.
        Parameters:
        keyName - non-null key name.
        Returns:
        non-null result message string (empty) from the delete operation.
        Throws:
        P4JavaException - if an error occurs processing this method and its parameters.
        Since:
        2013.1

      • setKey

        java.lang.String setKey​(java.lang.String keyName,
                        java.lang.String value,
                        KeyOptions opts)
                 throws P4JavaException
        Create, set or delete a key on a Perforce server. This method can be used to create, set, increment, or delete a key according to the specific options set in the associated options object.
        Parameters:
        keyName - non-null key name.
        value - value the key should be set to; can be null if the set operation is an increment.
        opts - KeyOptions object describing optional parameters; if null, no options are set.
        Returns:
        possibly-null current (post-set, post-increment) value; may be empty if the operation was a delete.
        Throws:
        P4JavaException - if an error occurs processing this method and its parameters.
        Since:
        2013.1

      • getKey

        java.lang.String getKey​(java.lang.String keyName)
                 throws P4JavaException
        Get the value of a named Perforce key from the Perforce server. Note that this method will return a zero string (i.e. "0") if the named key doesn't exist (rather than throw an exception); use getKeys to see if a key actually exists before you use it.
        Parameters:
        keyName - non-null key name.
        Returns:
        non-null (but possibly zero, if non-existing) key value associated with keyName.
        Throws:
        P4JavaException - if an error occurs processing this method and its parameters.
        Since:
        2013.1