ViewerId (SmartInspect Java Client Library 3.5.0 API)

java.lang.Object
- com.gurock.smartinspect.ViewerId

```
public final class ViewerId
extends Object
```
Specifies the viewer for displaying the title or data of a Log Entry in the Console. There are many viewers available for displaying the data of a Log Entry in different ways. For example, there are viewers that can display lists, tables, binary dumps of data or even websites. Every viewer in the Console has a corresponding so-called viewer context in this library which can be used to send custom logging information. To get started, please see the documentation of the Session.logCustomContext method and ViewerContext class. This class is fully threadsafe.

Field Summary

Fields
Modifier and Type	Field and Description
`static ViewerId`	`Binary` Instructs the Console to display the data of a Log Entry as a binary dump using a read-only hex editor.
`static ViewerId`	`Bitmap` Instructs the Console to display the data of a Log Entry as bitmap image.
`static ViewerId`	`Data` Instructs the Console to display the data of a Log Entry in a read-only text field.
`static ViewerId`	`HtmlSource` Instructs the Console to display the data of a Log Entry as HTML source with syntax highlighting.
`static ViewerId`	`Icon` Instructs the Console to display the data of a Log Entry as Windows icon.
`static ViewerId`	`IniSource` Instructs the Console to display the data of a Log Entry as INI source with syntax highlighting.
`static ViewerId`	`Inspector` Instructs the Console to display the data of a Log Entry using an object inspector.
`static ViewerId`	`JavaScriptSource` Instructs the Console to display the data of a Log Entry as JavaScript source with syntax highlighting.
`static ViewerId`	`Jpeg` Instructs the Console to display the data of a Log Entry as a JPEG image.
`static ViewerId`	`List` Instructs the Console to display the data of a Log Entry as a list.
`static ViewerId`	`Metafile` Instructs the Console to display the data of a Log Entry as Windows Metafile image.
`static ViewerId`	`None` Instructs the Console to use no viewer at all.
`static ViewerId`	`PerlSource` Instructs the Console to display the data of a Log Entry as Perl source with syntax highlighting.
`static ViewerId`	`PythonSource` Instructs the Console to display the data of a Log Entry as Python source with syntax highlighting.
`static ViewerId`	`SqlSource` Instructs the Console to display the data of a Log Entry as SQL source with syntax highlighting.
`static ViewerId`	`Table` Instructs the Console to display the data of a Log Entry as a table.
`static ViewerId`	`Title` Instructs the Console to display the title of a Log Entry in a read-only text field.
`static ViewerId`	`ValueList` Instructs the Console to display the data of a Log Entry as a key/value list.
`static ViewerId`	`VbScriptSource` Instructs the Console to display the data of a Log Entry as VBScript source with syntax highlighting.
`static ViewerId`	`Web` Instructs the Console to display the data of a Log Entry as a website.
`static ViewerId`	`XmlSource` Instructs the Console to display the data of a Log Entry as XML source with syntax highlighting.

Method Summary

All Methods Instance Methods Concrete Methods
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.

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - None
```
public static final ViewerId None
```
    Instructs the Console to use no viewer at all.
  - Title
```
public static final ViewerId Title
```
    Instructs the Console to display the title of a Log Entry in a read-only text field.
  - Data
```
public static final ViewerId Data
```
    Instructs the Console to display the data of a Log Entry in a read-only text field.
  - List
```
public static final ViewerId List
```
    Instructs the Console to display the data of a Log Entry as a list.
  - ValueList
```
public static final ViewerId ValueList
```
    Instructs the Console to display the data of a Log Entry as a key/value list.
  - Inspector
```
public static final ViewerId Inspector
```
    Instructs the Console to display the data of a Log Entry using an object inspector.
  - Table
```
public static final ViewerId Table
```
    Instructs the Console to display the data of a Log Entry as a table.
  - Web
```
public static final ViewerId Web
```
    Instructs the Console to display the data of a Log Entry as a website.
  - Binary
```
public static final ViewerId Binary
```
    Instructs the Console to display the data of a Log Entry as a binary dump using a read-only hex editor.
  - HtmlSource
```
public static final ViewerId HtmlSource
```
    Instructs the Console to display the data of a Log Entry as HTML source with syntax highlighting.
  - JavaScriptSource
```
public static final ViewerId JavaScriptSource
```
    Instructs the Console to display the data of a Log Entry as JavaScript source with syntax highlighting.
  - VbScriptSource
```
public static final ViewerId VbScriptSource
```
    Instructs the Console to display the data of a Log Entry as VBScript source with syntax highlighting.
  - PerlSource
```
public static final ViewerId PerlSource
```
    Instructs the Console to display the data of a Log Entry as Perl source with syntax highlighting.
  - SqlSource
```
public static final ViewerId SqlSource
```
    Instructs the Console to display the data of a Log Entry as SQL source with syntax highlighting.
  - IniSource
```
public static final ViewerId IniSource
```
    Instructs the Console to display the data of a Log Entry as INI source with syntax highlighting.
  - PythonSource
```
public static final ViewerId PythonSource
```
    Instructs the Console to display the data of a Log Entry as Python source with syntax highlighting.
  - XmlSource
```
public static final ViewerId XmlSource
```
    Instructs the Console to display the data of a Log Entry as XML source with syntax highlighting.
  - Bitmap
```
public static final ViewerId Bitmap
```
    Instructs the Console to display the data of a Log Entry as bitmap image.
  - Jpeg
```
public static final ViewerId Jpeg
```
    Instructs the Console to display the data of a Log Entry as a JPEG image.
  - Icon
```
public static final ViewerId Icon
```
    Instructs the Console to display the data of a Log Entry as Windows icon.
  - Metafile
```
public static final ViewerId Metafile
```
    Instructs the Console to display the data of a Log Entry as Windows Metafile image.
- Method Detail
  - toString
```
public String toString()
```
    Overridden. Creates and returns a string representation of this object.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object. The return value is either the name of this Enum object if set or the integer value converted to a string.
  - 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.

Class ViewerId

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

None

Title

Data

List

ValueList

Inspector

Table

Web

Binary

HtmlSource

JavaScriptSource

VbScriptSource

PerlSource

SqlSource

IniSource

PythonSource

XmlSource

Bitmap

Jpeg

Icon

Metafile

Method Detail

toString

getIntValue

equals

less

lessEqual

greater

greaterEqual