Property Detail

• final java.lang.Class<T> propertyClass

  The class object used to instantiate a new branch value.

Constructor Detail

• Branches(java.lang.Class<T> propertyClass)

  Constructs the class with the specified factory class.

  Parameters:

  propertyClass - The class that is used to instantiate a new property object.

Method Detail

• T add(T branch)

  Adds a branch object as protected.

  Note:

  If the branch is already defined, the config will be overwritten.

  throws:

  BranchException when a branch is already protected.

  Parameters:

  branch - The properties of a branch that is protected.

  Returns:

  The object that was added.

• void add(java.util.List<T> branches)

  Adds a list of branches to the map.

  Parameters:

  branches - The branches to add as protected.

• T addMap(java.util.Map branch)

  Add a branch map into the object. This map must follow the syntax of the Groovy Map Object Constructor.

  Parameters:

  branch - The branch to add.

  Returns:

  The object that was added

• void addMap(java.util.List<java.util.Map> branches)

  Adds a list of branches to the protected maps. The elements of the list must follow the syntax of the Groovy Map Object Constructor.

  Parameters:

  branches - The branches to add as protected.

• T get(java.lang.String branchName)

  Gets a protected branch's properties from the map. @Note: This method is used to access the property based on raw branch name or name pattern. Usually we should use getByPattern(String) to find the branch properties.

  Parameters:

  branchName - The name or the pattern of the branch to retrieve

  Returns:

  The object for the branch name or null if there is no branch of the corresponding name.

• T getByPattern(java.lang.String branchName)

  Gets a protected branch's properties from the map by name pattern. @Note: This is the recommended method to find a branch property.

  Parameters:

  branchName - The name of the branch to retrieve

  Returns:

  The object for the branch name or null if there is no branch of the corresponding name.

• boolean isProtected(java.lang.String branchName)

  Checks if a given branch name is protected.

  Parameters:

  branchName - The name of the branch to check.

  Returns:

  True if the branch is protected, false otherwise.

• T remove(java.lang.String branchName)

  Removes a branch from the protected list.

  Parameters:

  branchName - The name of the branch to remove.

  Returns:

  The object that was removed or null if none was removed