com.gurock.smartinspect

Class SourceId

java.lang.Object

com.gurock.smartinspect.SourceId

public final class SourceId
extends Object

Used in the logSource methods of the Session class to specify the type of source code.

This class is fully thread-safe.

Field Summary

Fields

Modifier and Type	Field and Description
static SourceId	Html Instructs the logSource methods of the Session class to choose syntax highlighting for HTML.
static SourceId	Ini Instructs the logSource methods of the Session class to choose syntax highlighting for INI files.
static SourceId	JavaScript Instructs the logSource methods of the Session class to choose syntax highlighting for JavaScript.
static SourceId	Perl Instructs the logSource methods of the Session class to choose syntax highlighting for Perl.
static SourceId	Python Instructs the logSource methods of the Session class to choose syntax highlighting for Python.
static SourceId	Sql Instructs the logSource methods of the Session class to choose syntax highlighting for SQL.
static SourceId	VbScript Instructs the logSource methods of the Session class to choose syntax highlighting for VBScript.
static SourceId	Xml Instructs the logSource methods of the Session class to choose syntax highlighting for XML.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Indicates whether some other object is equal to this one.
int	getIntValue() Returns the integer value of this enum.
boolean	greater(com.gurock.smartinspect.Enum en) Indicates whether the integer value of this Enum is greater than the integer value of some other Enum.
boolean	greaterEqual(com.gurock.smartinspect.Enum en) Indicates whether the integer value of this Enum is greater than or equal to the integer value of some other Enum.
boolean	less(com.gurock.smartinspect.Enum en) Indicates whether the integer value of this Enum is less than the integer value of some other Enum.
boolean	lessEqual(com.gurock.smartinspect.Enum en) Indicates whether the integer value of this Enum is less than or equal to the integer value of some other Enum.
String	toString() Overridden.
protected ViewerId	toViewerId() Returns the related viewer ID for this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

Html

public static final SourceId Html

Instructs the logSource methods of the Session class to choose syntax highlighting for HTML.

JavaScript

public static final SourceId JavaScript

Instructs the logSource methods of the Session class to choose syntax highlighting for JavaScript.

VbScript

public static final SourceId VbScript

Instructs the logSource methods of the Session class to choose syntax highlighting for VBScript.

Perl

public static final SourceId Perl

Instructs the logSource methods of the Session class to choose syntax highlighting for Perl.

Sql

public static final SourceId Sql

Instructs the logSource methods of the Session class to choose syntax highlighting for SQL.

Ini

public static final SourceId Ini

Instructs the logSource methods of the Session class to choose syntax highlighting for INI files.

Python

public static final SourceId Python

Instructs the logSource methods of the Session class to choose syntax highlighting for Python.

Xml

public static final SourceId Xml

Instructs the logSource methods of the Session class to choose syntax highlighting for XML.

Method Detail

toString

public String toString()

Overridden. Creates and returns a string representation of this object.

Returns:

A string representation of this object

toViewerId

protected ViewerId toViewerId()

Returns the related viewer ID for this object.

Returns:

The related viewer ID

getIntValue

public int getIntValue()

Returns the integer value of this enum.

Returns:

The integer value of this enum. For a string representation of this Enum object, refer to the documentation of the toString method.

equals

public boolean equals(Object o)

Indicates whether some other object is equal to this one.

This method returns true if the supplied Object is an Enum and has the same integer value as returned by the getIntValue() method of this object. If the supplied Object is not an Enum, this method calls the equals method of the parent class.

Overrides:

equals in class Object

Parameters:

o - The object to compare this enum with.

Returns:

True if the supplied object equals this enum and false otherwise.

less

public boolean less(com.gurock.smartinspect.Enum en)

Indicates whether the integer value of this Enum is less than the integer value of some other Enum.

Parameters:

en - The enum to compare this enum with.

Returns:

True if the integer value of this Enum is less than the integer value of the supplied Enum and false otherwise.

lessEqual

public boolean lessEqual(com.gurock.smartinspect.Enum en)

Indicates whether the integer value of this Enum is less than or equal to the integer value of some other Enum.

Parameters:

en - The enum to compare this enum with.

Returns:

True if the integer value of this Enum is less than or equal to the integer value of the supplied Enum and false otherwise.

greater

public boolean greater(com.gurock.smartinspect.Enum en)

Indicates whether the integer value of this Enum is greater than the integer value of some other Enum.

Parameters:

en - The enum to compare this enum with.

Returns:

True if the integer value of this Enum is greater than the integer value of the supplied Enum and false otherwise.

greaterEqual

public boolean greaterEqual(com.gurock.smartinspect.Enum en)

Indicates whether the integer value of this Enum is greater than or equal to the integer value of some other Enum.

Parameters:

en - The enum to compare this enum with.

Returns:

True if the integer value of this Enum is greater than or equal to the integer value of the supplied Enum and false otherwise.