com.microsoft.tfs.core.clients.build
Interface IBuildInformation


public interface IBuildInformation


Method Summary
 IBuildInformationNode createNode()
          Adds an information node to the collection.
 void delete()
          Deletes the collection of information nodes from the server.
 IBuildInformationNode getNode(int id)
          Returns the information node with the given Id.
 IBuildInformationNode[] getNodes()
          The information nodes in the collection.
 IBuildInformationNode[] getNodesByType(java.lang.String type)
          Returns the information nodes in Nodes (non-recursive) with the given type.
 IBuildInformationNode[] getNodesByType(java.lang.String type, boolean recursive)
          Returns the information nodes in Nodes with the given type and recursion type.
 IBuildInformationNode[] getNodesByTypes(java.lang.String[] types)
          Returns the information nodes in Nodes (non-recursive) with the given type(s).
 IBuildInformationNode[] getNodesByTypes(java.lang.String[] types, boolean recursive)
          Returns the information nodes in Nodes with the given type(s) and recursion type.
 IBuildInformationNode[] getSortedNodes(java.util.Comparator<IBuildInformationNode> comparer)
          Returns a sorted list of the information nodes in Nodes and all subtrees (recursive).
 IBuildInformationNode[] getSortedNodesByType(java.lang.String type, java.util.Comparator<IBuildInformationNode> comparer)
          Returns a sorted list of the information nodes in Nodes and all subtrees (recursive) with the given type.
 IBuildInformationNode[] getSortedNodesByTypes(java.lang.String[] types, java.util.Comparator<IBuildInformationNode> comparer)
          Returns a sorted list of the information nodes in Nodes and all subtrees (recursive) with the given type(s).
 void save()
          Persists any changes to the collection of information nodes (and all subtrees) to the server.
 

Method Detail

getNodes

IBuildInformationNode[] getNodes()
The information nodes in the collection.

Returns:

getNode

IBuildInformationNode getNode(int id)
Returns the information node with the given Id.

Parameters:
id - The Id of the node to get.
Returns:
The node with the given Id, or null if no node was found.

getNodesByType

IBuildInformationNode[] getNodesByType(java.lang.String type)
Returns the information nodes in Nodes (non-recursive) with the given type.

Parameters:
type - The type for which nodes are returned.
Returns:
The list of nodes in Nodes with the given type.

getNodesByType

IBuildInformationNode[] getNodesByType(java.lang.String type,
                                       boolean recursive)
Returns the information nodes in Nodes with the given type and recursion type.

Parameters:
type - The type for which nodes are returned.
recursive -
Returns:
The list of nodes in Nodes with the given type.

getNodesByTypes

IBuildInformationNode[] getNodesByTypes(java.lang.String[] types)
Returns the information nodes in Nodes (non-recursive) with the given type(s).

Parameters:
types - The type(s) for which nodes are returned.
Returns:
The list of nodes in Nodes with the given type(s).

getNodesByTypes

IBuildInformationNode[] getNodesByTypes(java.lang.String[] types,
                                        boolean recursive)
Returns the information nodes in Nodes with the given type(s) and recursion type.

Parameters:
types - The type(s) for which nodes are returned.
recursive -
Returns:
The list of nodes in Nodes with the given type(s).

getSortedNodesByType

IBuildInformationNode[] getSortedNodesByType(java.lang.String type,
                                             java.util.Comparator<IBuildInformationNode> comparer)
Returns a sorted list of the information nodes in Nodes and all subtrees (recursive) with the given type. Sorting will be first by hierarchy, and then by the given comparer.

Parameters:
type - The type for which nodes are returned.
comparer - The comparison used to sort nodes at the same level in the hierarchy.
Returns:
A sorted list of the information nodes in Nodes and all subtrees with the given type.

getSortedNodesByTypes

IBuildInformationNode[] getSortedNodesByTypes(java.lang.String[] types,
                                              java.util.Comparator<IBuildInformationNode> comparer)
Returns a sorted list of the information nodes in Nodes and all subtrees (recursive) with the given type(s). Sorting will be first by hierarchy, and then by the given comparer.

Parameters:
types - The type(s) for which nodes are returned.
comparer - The comparison used to sort nodes at the same level in the hierarchy.
Returns:
A sorted list of the information nodes in Nodes and all subtrees with the given type(s).

getSortedNodes

IBuildInformationNode[] getSortedNodes(java.util.Comparator<IBuildInformationNode> comparer)
Returns a sorted list of the information nodes in Nodes and all subtrees (recursive). Sorting will be first by hierarchy, and then by the given comparer.

Parameters:
comparer - The comparison used to sort nodes at the same level in the hierarchy.
Returns:
A sorted list of the information nodes in Nodes and all subtrees.

createNode

IBuildInformationNode createNode()
Adds an information node to the collection.

Returns:
The new information node.

delete

void delete()
Deletes the collection of information nodes from the server.


save

void save()
Persists any changes to the collection of information nodes (and all subtrees) to the server.



© 2015 Microsoft. All rights reserved.