PTP
Release 5.0

org.eclipse.ptp.ui.model
Interface IElementSet

All Superinterfaces:
java.lang.Cloneable, java.lang.Comparable<IElement>, org.eclipse.core.runtime.IAdaptable, IElement
All Known Subinterfaces:
IElementHandler
All Known Implementing Classes:
ElementHandler, ElementSet

public interface IElementSet
extends IElement


Method Summary
 void addElements(IElement[] elements)
          Adds given elements to this set
 void addMatchSet(java.lang.String setID)
          Store a list which set also contains the same element Adds to match set of given set id
 void clean()
          Remove all the elements in this set
 boolean contains(IElement element)
          Returns whether this set contains given element
 boolean contains(java.lang.String id)
          Returns whether this set contains given element id
 boolean containsMatchSet(java.lang.String setID)
          Returns whether given set id contains in match list
 int findIndexByID(java.lang.String id)
          Returns position of given element id
 int findIndexByName(java.lang.String name)
          Returns position of given element name
 IElement getElement(int index)
          Returns element by given index
 IElement getElementByID(java.lang.String id)
          Returns element by given element id
 IElement getElementByName(java.lang.String name)
          Returns element by given element name
 IElement[] getElements()
          Returns an array of elements of this set
 java.lang.String[] getMatchSetIDs()
          Returns an array of match set id
 boolean isRootSet()
          Returns whether this set is root or not
 void removeElement(java.lang.String id)
          Removes Element from this set
 void removeElements(IElement[] elements)
          Removes given elements from this set
 void removeMatchSet(java.lang.String setID)
          Removes match sets of given set id
 int size()
          Returns total elements of this set
 
Methods inherited from interface org.eclipse.ptp.ui.model.IElement
cloneElement, getID, getName, getParent, getPElement, isRegistered, isSelected, setRegistered, setSelected
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Method Detail

removeElement

void removeElement(java.lang.String id)
Removes Element from this set

Parameters:
element - id

addElements

void addElements(IElement[] elements)
Adds given elements to this set

Parameters:
elements -

removeElements

void removeElements(IElement[] elements)
Removes given elements from this set

Parameters:
elements -

getElements

IElement[] getElements()
Returns an array of elements of this set

Returns:
an array of elements

isRootSet

boolean isRootSet()
Returns whether this set is root or not

Returns:
true if this set is root

getElementByID

IElement getElementByID(java.lang.String id)
Returns element by given element id

Parameters:
id - element id
Returns:
element

getElementByName

IElement getElementByName(java.lang.String name)
Returns element by given element name

Parameters:
name - element name
Returns:
element

getElement

IElement getElement(int index)
Returns element by given index

Parameters:
index -
Returns:
element

size

int size()
Returns total elements of this set

Returns:
total elements of this set

clean

void clean()
Remove all the elements in this set


contains

boolean contains(IElement element)
Returns whether this set contains given element

Parameters:
element -
Returns:
whether this set contains given element

contains

boolean contains(java.lang.String id)
Returns whether this set contains given element id

Parameters:
id -
Returns:
whether this set contains given element id

addMatchSet

void addMatchSet(java.lang.String setID)
Store a list which set also contains the same element Adds to match set of given set id

Parameters:
setID - set id

removeMatchSet

void removeMatchSet(java.lang.String setID)
Removes match sets of given set id

Parameters:
setID - set id

containsMatchSet

boolean containsMatchSet(java.lang.String setID)
Returns whether given set id contains in match list

Parameters:
setID -
Returns:
true if given set id contains in match list

getMatchSetIDs

java.lang.String[] getMatchSetIDs()
Returns an array of match set id

Returns:
an array of match set id

findIndexByID

int findIndexByID(java.lang.String id)
Returns position of given element id

Parameters:
id - element id
Returns:
position of given element id

findIndexByName

int findIndexByName(java.lang.String name)
Returns position of given element name

Parameters:
name - element name
Returns:
position of given element name

PTP
Release 5.0

Copyright (c) 2011 IBM Corporation and others. All Rights Reserved.