Hyperic HQ Plugin API v. 2.5.dev

## net.hyperic.hq.product
Class TypeInfo

    java.lang.Object
      net.hyperic.hq.product.TypeInfo

Direct Known Subclasses:
  PlatformTypeInfo, ServerTypeInfo, ServiceTypeInfo

public abstract class TypeInfo
extends java.lang.Object

Carry information about appdef entity type

Field Summary
`static int` `TYPE_PLATFORM`
`static int` `TYPE_SERVER`
`static int` `TYPE_SERVICE`

Constructor Summary
`TypeInfo()`

Method Summary
`boolean` `equals(java.lang.Object otherObj)`
`static java.lang.String` `formatName(java.lang.String name)`
`java.lang.String` `getFormattedName()` Getter for formatted property name, lower cased spaces converted to hypens.
`java.lang.String` `getName()` Getter for property name.
`java.lang.String[]` `getPlatformTypes()`
`abstract int` `getType()`
`java.lang.String` `getVersion()` Get the version for a server
`boolean` `isServer(java.lang.String name)` Test that entity is a server type that matches given server name.
`boolean` `isServer(java.lang.String name, java.lang.String version)` Test that entity is a server type that matches given server name and version.
`boolean` `isService(java.lang.String name)` Test that entity is a service type that matches given service name.
`boolean` `isService(java.lang.String name, java.lang.String version)` Test that entity is a service type that matches given service name and server version.
`boolean` `isUnixPlatform()`
`boolean` `isVersion(java.lang.String version)` Test that entity server or service type version matches the given version.
`boolean` `isWin32Platform()`
`void` `setName(java.lang.String name)` Setter for property name.

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

Field Detail

### TYPE_PLATFORM

    public static final int TYPE_PLATFORM

See Also:
  Constant Field Values

### TYPE_SERVER

    public static final int TYPE_SERVER

See Also:
  Constant Field Values

### TYPE_SERVICE

    public static final int TYPE_SERVICE

See Also:
  Constant Field Values

Constructor Detail

### TypeInfo

    public TypeInfo()

Method Detail

### getType

    public abstract int getType()

### formatName

    public static java.lang.String formatName(java.lang.String name)

### getFormattedName

    public java.lang.String getFormattedName()

  Getter for formatted property name, lower cased spaces converted to hypens.

  Returns:
    Value of formatted property name.

### getName

    public java.lang.String getName()

  Getter for property name.

  Returns:
    Value of property name.

### setName

    public void setName(java.lang.String name)

  Setter for property name.

  Parameters:
    `name` - New value of property name.

### equals

    public boolean equals(java.lang.Object otherObj)

### isServer

    public boolean isServer(java.lang.String name)

  Test that entity is a server type that matches given server name.

### isServer

    public boolean isServer(java.lang.String name,
                            java.lang.String version)

  Test that entity is a server type that matches given server name and version.

### isService

    public boolean isService(java.lang.String name)

  Test that entity is a service type that matches given service name.

### isService

    public boolean isService(java.lang.String name,
                             java.lang.String version)

  Test that entity is a service type that matches given service name and server version.

### getVersion

    public java.lang.String getVersion()

  Get the version for a server

  Throws:
    `java.lang.IllegalArgumentException` - If invoked on a type other than TYPE_SERVER or TYPE_SERVICE.

### isVersion

    public boolean isVersion(java.lang.String version)

  Test that entity server or service type version matches the given version.

  Throws:
    `java.lang.IllegalArgumentException` - If invoked on a type other than TYPE_SERVER or TYPE_SERVICE.

### getPlatformTypes

    public java.lang.String[] getPlatformTypes()

  Returns:
    list of supported platforms for this type.

### isUnixPlatform

    public boolean isUnixPlatform()

  Returns:
    true if the platforms for this type are all in the Unix family.

### isWin32Platform

    public boolean isWin32Platform()

  Returns:
    true if the platforms for this type are all in the Win32 family.

Hyperic HQ Plugin API v. 2.5.dev

Copyright © 2004-2005 Hyperic LLC support@hyperic.net, All Rights Reserved.