JanosVM v1.0 API

edu.utah.janosvm.kit.comm.jsi
Class JSIPropertyInfo

java.lang.Object
  |
  +--edu.utah.janosvm.kit.comm.jsi.JSIPropertyInfo

public final class JSIPropertyInfo
extends java.lang.Object

A simple class used to describe a JSI property.


Field Summary
private  int commands
          A bitmask of the message types that the property understands.
private  java.lang.String name
          The name of the property.
private  java.lang.String specifiers
          The specifier value needed to address the property.
private  java.lang.String usage
          A description of the property and its uses.
 
Constructor Summary
JSIPropertyInfo(java.lang.String name, int commands, java.lang.String usage)
          Construct a property info with the given values and no specifier value.
JSIPropertyInfo(java.lang.String name, int commands, java.lang.String specifiers, java.lang.String usage)
          Construct a property info with the given values.
 
Method Summary
(package private)  java.lang.String encode()
           
 boolean equals(java.lang.Object obj)
           
 int getCommands()
           
 java.lang.String getName()
           
 java.lang.String getSpecifiers()
           
 int hashCode()
           
(package private) static JSIPropertyInfo instantiate(java.lang.String str)
          Instantiate a JSIPropertyInfo object from an encoded string.
 java.lang.String toString()
           
 java.lang.String usage()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait, wait0
 

Field Detail

name

private java.lang.String name
The name of the property.

commands

private int commands
A bitmask of the message types that the property understands.

specifiers

private java.lang.String specifiers
The specifier value needed to address the property.

usage

private java.lang.String usage
A description of the property and its uses.
Constructor Detail

JSIPropertyInfo

public JSIPropertyInfo(java.lang.String name,
                       int commands,
                       java.lang.String specifiers,
                       java.lang.String usage)
Construct a property info with the given values.
Parameters:
name - The name of the property.
commands - A bitmask of the message types that the property
commands - understands.
specifiers - The specifier value needed to address the property.
usage - A description of the property and its uses.

JSIPropertyInfo

public JSIPropertyInfo(java.lang.String name,
                       int commands,
                       java.lang.String usage)
Construct a property info with the given values and no specifier value.
Parameters:
name - The name of the property.
commands - A bitmask of the message types that the property
commands - understands.
usage - A description of the property and its uses.
Method Detail

getName

public java.lang.String getName()
Returns:
The name of the property.

getCommands

public int getCommands()
Returns:
The bitmask of message types the property understands.

getSpecifiers

public java.lang.String getSpecifiers()
Returns:
The specifier values needed to address the property.

usage

public java.lang.String usage()
Returns:
A description of the property and its uses.

encode

java.lang.String encode()
Returns:
An encoded version of the property info structure.

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

instantiate

static JSIPropertyInfo instantiate(java.lang.String str)
Instantiate a JSIPropertyInfo object from an encoded string.
Parameters:
str - The string containing the encoded version of a
str - JSIPropertyInfo
Returns:
The decoded JSIPropertyInfo or null if it failed.

JanosVM v1.0 API

This documentation is Copyright (C) 2000-2003 The University of Utah. All Rights Reserved. See the documentation license for distribution terms and restrictions.
Documentation, software, and mailing lists for the JanosVM can be found at the Janos Project web page: http://www.cs.utah.edu/flux/janos/
Generated on Feb 13, 2003