IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.models.behavior.common
Interface LTAnnotation

All Superinterfaces:
CBActionElement, com.ibm.rational.test.common.models.behavior.CBAssetMigration, CBBlock, com.ibm.rational.test.common.models.behavior.CBBlockElement, com.ibm.rational.test.common.models.behavior.edit.CBCloneable, com.ibm.rational.test.common.models.behavior.edit.CBEdit, com.ibm.rational.test.common.models.behavior.errors.CBErrorHost, CBNamedElement, com.ibm.rational.test.common.models.behavior.internal.CBTempData, org.eclipse.emf.ecore.EObject, IAdaptable, LTBlock, org.eclipse.emf.common.notify.Notifier

public interface LTAnnotation
extends LTBlock, com.ibm.rational.test.common.models.behavior.CBAssetMigration

A representation of the model object 'LT Annotation'.

The following features are supported:

See Also:
CommonPackage.getLTAnnotation()

Field Summary
 
Fields inherited from interface com.ibm.rational.test.common.models.behavior.edit.CBEdit
MOVE_OLD_PARENT_FLAG
 
Method Summary
 void calculateBinary()
          calculate the binary attribute of this object.
 void clearBytes()
           
 String getAsciifiedString()
           
 byte[] getBytes()
           
 InputStream getByteStream()
          Returns an input stream on the bytes read in by the annotation.
 String getCharset()
          Returns the value of the 'Charset' attribute.
 String getString()
           
 boolean isBinary()
          Returns the value of the 'Binary' attribute.
 void setAsciifiedString(String string)
           
 void setBinary(boolean value)
          Sets the value of the 'Binary' attribute
 void setBytes(byte[] bytes)
           
 void setByteStream(InputStream stream)
          annotates using a stream.
 void setCharset(String value)
          Sets the value of the 'Charset' attribute
 void setString(String string)
           
 
Methods inherited from interface com.ibm.rational.test.lt.models.behavior.common.LTBlock
addProxy, createProxy, isProxyReference, processRemoval, removeProxy
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.CBBlock
getActions, getCBErrors, getCBRequirementTarget, processRemoval, setCBRequirementTarget
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.CBBlockElement
isControlBlock
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.CBActionElement
canDisable, canEnable, enable, getAction, getBooleanProperty, getByteProperty, getCharProperty, getDisabledCount, getDoubleProperty, getFloatProperty, getInheritedCBActionElements, getIntProperty, getLongProperty, getMovingFrom, getParent, getShortProperty, getStringProperty, getTransformID, getType, isAlwaysLog, isEnabled, isMoving, move, resetDisabledCount, setAction, setAlwaysLog, setDisabledCount, setEnabled, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setTransformID, setType, validate
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.CBNamedElement
getDescription, getId, getName, getStopId, setDescription, setId, setName
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.internal.CBTempData
getTempAttribute, getTempAttribute, getTempAttributes, setTempAttribute, setTempAttribute, unsetTempAttribute
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.edit.CBCloneable
doClone, isCloneable
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.edit.CBEdit
canCopy, canMove, doCopy, doMove, findProblemsWithCopy, findProblemsWithMove
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.errors.CBErrorHost
canHostCBErrors, isErrorGenerator
 
Methods inherited from interface com.ibm.rational.test.common.models.behavior.CBAssetMigration
migrate, needMigration
 

Method Detail

isBinary

boolean isBinary()
Returns the value of the 'Binary' attribute. The default value is "true".

If the meaning of the 'Binary' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Binary' attribute.
See Also:
LTAnnotation.setBinary(boolean), CommonPackage.getLTAnnotation_Binary()

setBinary

void setBinary(boolean value)
Sets the value of the 'Binary' attribute.

Parameters:
value - the new value of the 'Binary' attribute.
See Also:
LTAnnotation.isBinary()

getCharset

String getCharset()
Returns the value of the 'Charset' attribute. The default value is "UTF-8".

If the meaning of the 'Charset' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Charset' attribute.
See Also:
LTAnnotation.setCharset(String), CommonPackage.getLTAnnotation_Charset()

setCharset

void setCharset(String value)
Sets the value of the 'Charset' attribute.

Parameters:
value - the new value of the 'Charset' attribute.
See Also:
LTAnnotation.getCharset()

getString

String getString()


setString

void setString(String string)


setAsciifiedString

void setAsciifiedString(String string)


getAsciifiedString

String getAsciifiedString()


setBytes

void setBytes(byte[] bytes)


clearBytes

void clearBytes()


getBytes

byte[] getBytes()


getByteStream

InputStream getByteStream()
Returns an input stream on the bytes read in by the annotation.

Returns:
InputStream - that can be read off of.

setByteStream

void setByteStream(InputStream stream)
annotates using a stream. The annotation will read from the stream passed in until no more data can be read and annotate it.

Parameters:
stream - - the stream that contains the data to be read from

calculateBinary

void calculateBinary()
calculate the binary attribute of this object. The base implementation of this method does not calculate the value of the binary attribute. Extensions may override this method to write custom implementations to figure out if the data being stored in this annotation is text or binary. These methods should call setBinary() with the calculated value.


IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.