|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.connector2.hod.J2HODScreenRecord
This class represents a screen record and it is used to update the host screen by updating a screen record and sending it as an input to execute. This class is also used to compare a current screen record information against another screen record for their match.
Constructor Summary | |
---|---|
J2HODScreenRecord()
Creates an instance of J2HODScreenRecord. |
|
J2HODScreenRecord(int numRows,
int numColumns)
Creates an instance of J2HODScreenRecord. |
Method Summary | |
---|---|
boolean |
checkBytes(byte[] b)
Compares the input byte array. |
boolean |
checkBytes(byte[] b,
int row,
int column,
boolean caseSense,
boolean enableException)
Compares input byte array with the screen at a specified position. |
boolean |
checkBytes(java.lang.String s,
int row,
int column,
boolean caseSense,
boolean enableException)
Compares the input string with specified position. |
boolean |
checkBytes(java.lang.String s,
int startRow,
int startColumn,
int endRow,
int endColumn,
boolean caseSense,
boolean enableException)
Compares the input string in a specified region. |
java.lang.Object |
clone()
Clones current screen record. |
boolean |
equals(java.lang.Object obj)
Compares two objects for equality. |
byte[] |
getBytes()
Get a byte array representing the screen. |
java.lang.String |
getRecordName()
Gets a record name. |
java.lang.String |
getRecordShortDescription()
Gets a short record description. |
int |
hashCode()
Generates a hash code for the receiver. |
void |
read(java.io.InputStream istream)
Reads input stream and store it as a byte array. |
void |
setBytes(byte[] b)
Sets byte array. |
void |
setBytes(byte[] b,
int startRow,
int startColumn)
Modify the byte array based on input byte array and specified position The row and column both start at 1. |
void |
setRecordName(java.lang.String recordName)
Sets a record name. |
void |
setRecordShortDescription(java.lang.String description)
Sets a short description of a record. |
void |
setString(java.lang.String s,
int startRow,
int startColumn)
Modify the byte array based on a string and a cursor position (represented in row and column). |
java.lang.String |
toString()
Return a string representing a whole screen record. |
java.lang.String |
toString(int startRow,
int startColumn,
int endRow,
int endColumn)
Return a string representing a screen record based on specified start row, start column, end row, end column of the byte array. |
void |
write(java.io.OutputStream ostream)
Writes the screen record into an output stream. |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public J2HODScreenRecord()
public J2HODScreenRecord(int numRows, int numColumns)
numRows
- int - Number of rows on a session screen (must be greater than 0, otherwise default 24 will be used)numColumns
- int - Number of columns on a session screen (must be greater than 0, otherwise default 80 will be used)Method Detail |
public boolean checkBytes(byte[] b)
b
- byte[] - screen record in byte representationpublic boolean checkBytes(byte[] b, int row, int column, boolean caseSense, boolean enableException) throws java.lang.Exception
b
- byte[] - screen record in a byte array representationrow
- int - compare start rowcolumn
- int - compare start columncaseSense
- boolean - case sensitive(true) or not(false)enableException
- boolean - throw exception or notjava.lang.Exception
- - only if screen does not match and enableException is set to true.public boolean checkBytes(java.lang.String s, int startRow, int startColumn, int endRow, int endColumn, boolean caseSense, boolean enableException) throws java.lang.Exception
s
- String - screen record in a String representationstartRow
- int - compare start rowstartColumn
- int - compare start columnendRow
- int - compare end rowendColumn
- int - compare end columncaseSense
- boolean - case sensitive(true) or not(false)enableException
- boolean - throw exception or notjava.lang.Exception
- - only if screen does not match and enableException is set to true.public boolean checkBytes(java.lang.String s, int row, int column, boolean caseSense, boolean enableException) throws java.lang.Exception
s
- String - screen record in a String representationrow
- int - compare start rowcolumn
- int - compare start columncaseSense
- boolean - case sensitive(true) or not(false)enableException
- boolean - throw exception or notjava.lang.Exception
- - only if screen does not match and enableException is set to true.public java.lang.Object clone()
clone
in interface javax.resource.cci.Record
public boolean equals(java.lang.Object obj)
equals
in interface javax.resource.cci.Record
equals
in class java.lang.Object
obj
- Object - the Object to compare withHashtable
public byte[] getBytes()
setBytes(byte[])
public java.lang.String getRecordName()
getRecordName
in interface javax.resource.cci.Record
setRecordName(java.lang.String)
public java.lang.String getRecordShortDescription()
getRecordShortDescription
in interface javax.resource.cci.Record
setRecordShortDescription(java.lang.String)
public int hashCode()
hashCode
in interface javax.resource.cci.Record
hashCode
in class java.lang.Object
Hashtable
public void read(java.io.InputStream istream) throws java.io.IOException
read
in interface javax.resource.cci.Streamable
istream
- java.io.InputStreampublic void setBytes(byte[] b)
getBytes()
public void setBytes(byte[] b, int startRow, int startColumn) throws java.lang.Exception
byte
- b - byte arrayint
- startRow - start row numberint
- startColumn - start column numbergetBytes()
public void setRecordName(java.lang.String recordName)
setRecordName
in interface javax.resource.cci.Record
String
- recordNamegetRecordName()
public void setRecordShortDescription(java.lang.String description)
setRecordShortDescription
in interface javax.resource.cci.Record
String
- descriptiongetRecordShortDescription()
public void setString(java.lang.String s, int startRow, int startColumn) throws java.lang.Exception
s
- String - string replacementstartRow
- int - string replacement start rowstartColumn
- int - string replacement start columnjava.lang.Exception
- public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toString(int startRow, int startColumn, int endRow, int endColumn)
public void write(java.io.OutputStream ostream) throws java.io.IOException
write
in interface javax.resource.cci.Streamable
ostream
- java.io.OutputStream - output streamjava.io.IOException
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |