Interface ITriggerEntry

  • All Superinterfaces:
    IMapEntry
    All Known Implementing Classes:
    TriggerEntry

    public interface ITriggerEntry
    extends IMapEntry
    Describes a protection entry (line) in a Perforce triggers table. These are described in more detail in the various main Perforce admin documentation pages.
    • Method Detail

      • getName

        java.lang.String getName()
        Gets the trigger name.
        Returns:
        the trigger name
      • setName

        void setName​(java.lang.String name)
        Sets the trigger name.
        Parameters:
        name - the trigger name
      • setTriggerType

        void setTriggerType​(ITriggerEntry.TriggerType type)
        Sets the trigger type.
        Parameters:
        type - the trigger type
      • getPath

        java.lang.String getPath()
        For change and submit triggers, a file pattern to match files in the changelist. This file pattern can be an exclusion mapping (-pattern), to exclude files. For form triggers, the name of the form (branch, client, etc). For fix triggers 'fix' is required as the path value. For authentication triggers, 'auth' is required as the path value. For archive triggers, a file pattern to match the name of the file being accessed in the archive. Note that, due to lazy copying when branching files, the name of the file in the archive can not be the same as the name of the file in the depot. For command triggers, use the name of the command to match, e.g. 'pre-user-$cmd' or a regular expression, e.g. '(pre|post)-user-add'. *
        Returns:
        the depot file path pattern or form type
      • setPath

        void setPath​(java.lang.String path)
        For change and submit triggers, a file pattern to match files in the changelist. This file pattern can be an exclusion mapping (-pattern), to exclude files. For form triggers, the name of the form (branch, client, etc). For fix triggers 'fix' is required as the path value. For authentication triggers, 'auth' is required as the path value. For archive triggers, a file pattern to match the name of the file being accessed in the archive. Note that, due to lazy copying when branching files, the name of the file in the archive can not be the same as the name of the file in the depot. For command triggers, use the name of the command to match, e.g. 'pre-user-$cmd' or a regular expression, e.g. '(pre|post)-user-add'. *
        Parameters:
        path - the depot file path pattern or form type
      • getCommand

        java.lang.String getCommand()
        Gets the trigger command. If the command contains spaces, enclose it in double quotes.
        Returns:
        the trigger comamnd
      • setCommand

        void setCommand​(java.lang.String command)
        Sets the trigger command. If the command contains spaces, enclose it in double quotes.
        Parameters:
        command - the trigger command