com.starbase.starteam
Class ItemBehavior

java.lang.Object
  |
  +--com.starbase.starteam.ItemBehavior

public class ItemBehavior
extends java.lang.Object

A class that represents the behavior of an Item.

See Also:
Item

Field Summary
static int BRANCH_STATE_BRANCHABLE
           
static int BRANCH_STATE_BRANCHED
           
static int BRANCH_STATE_NOT_SUPPORTED
           
static int BRANCH_STATE_ROOT
           
 
Constructor Summary
ItemBehavior(ItemBehavior behavior)
          Constructs a new ItemBehavior that is a copy of an existing one.
 
Method Summary
 boolean equals(java.lang.Object source)
          returns true if this object instance is equal to the source
 boolean getBranchOnChange()
          Determines whether or not this ItemBehavior is set to branch on change.
 int getBranchState()
          Gets the branch state.
 ViewConfiguration getConfig()
          Gets this ItemBehavior's current configuration.
 boolean getFixConfig()
          Determines whether or not this item has a fixed configuration.
 int hashCode()
          returns a unique hash for all instances of this type
 void setBranchOnChange(boolean bBranchOnChange)
          Determines whether or not this ItemBehavior is set to branch on change.
 void setConfig(ViewConfiguration config)
          Changes this ItemBehavior to use the given configuration.
 void setFloatingConfig()
          Changes this ItemBehavior to use a floating configuration.
 java.lang.String toString()
          Returns a string representation of this configuration.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

BRANCH_STATE_BRANCHABLE

public static final int BRANCH_STATE_BRANCHABLE
See Also:
Constant Field Values

BRANCH_STATE_BRANCHED

public static final int BRANCH_STATE_BRANCHED
See Also:
Constant Field Values

BRANCH_STATE_ROOT

public static final int BRANCH_STATE_ROOT
See Also:
Constant Field Values

BRANCH_STATE_NOT_SUPPORTED

public static final int BRANCH_STATE_NOT_SUPPORTED
See Also:
Constant Field Values
Constructor Detail

ItemBehavior

public ItemBehavior(ItemBehavior behavior)
Constructs a new ItemBehavior that is a copy of an existing one.

Parameters:
behavior - The existing ItemBehavior to be copied.
Method Detail

getFixConfig

public boolean getFixConfig()
Determines whether or not this item has a fixed configuration.

Returns:
true if the item (or its parent item) has a fixed configuration.

getConfig

public ViewConfiguration getConfig()
Gets this ItemBehavior's current configuration.

Returns:
This ItemBehavior's current configuration.

setConfig

public void setConfig(ViewConfiguration config)
Changes this ItemBehavior to use the given configuration. Note that in order to apply the resulting behavior to an item, you must call Item.setBehavior().

Parameters:
config - The new configuration, or null to set a tip (floating) configuration.
See Also:
Item.setBehavior(com.starbase.starteam.ItemBehavior)

setFloatingConfig

public void setFloatingConfig()
Changes this ItemBehavior to use a floating configuration. Note that in order to apply the resulting behavior to an item, you must call Item.setBehavior().

See Also:
ItemBehavior.setConfig(com.starbase.starteam.ViewConfiguration), Item.setBehavior(com.starbase.starteam.ItemBehavior)

getBranchOnChange

public boolean getBranchOnChange()
Determines whether or not this ItemBehavior is set to branch on change.

Returns:
true if this ItemBehavior is set to branch on change; false otherwise.

setBranchOnChange

public void setBranchOnChange(boolean bBranchOnChange)
Determines whether or not this ItemBehavior is set to branch on change. Note that in order to apply the resulting behavior to an item, you must call Item.setBehavior().

Parameters:
bBranchOnChange - true if this ItemBehavior is set to branch on change; false otherwise.
See Also:
Item.setBehavior(com.starbase.starteam.ItemBehavior)

getBranchState

public int getBranchState()
Gets the branch state.

Returns:
The branch state.
See Also:
ItemBehavior.BRANCH_STATE_BRANCHABLE, ItemBehavior.BRANCH_STATE_BRANCHED, ItemBehavior.BRANCH_STATE_ROOT, ItemBehavior.BRANCH_STATE_NOT_SUPPORTED

toString

public java.lang.String toString()
Returns a string representation of this configuration.

Overrides:
toString in class java.lang.Object
Returns:
a string representation of this configuration

equals

public boolean equals(java.lang.Object source)
returns true if this object instance is equal to the source

Overrides:
equals in class java.lang.Object
Parameters:
source - Object the source to comapre with
Returns:
boolean true if this object is equal to the source

hashCode

public int hashCode()
returns a unique hash for all instances of this type

Overrides:
hashCode in class java.lang.Object
Returns:
int a unique hash for all instances of this type


StarTeam SDK 10.4, Build 36
Copyright © 2003-2008 Borland Software Corporation. All rights reserved.