public class Platform extends java.lang.Object implements Displayable, java.lang.Comparable
Constructor and Description |
---|
Platform(PlatformType type,
PlatformVersion version) |
Platform(PlatformType type,
PlatformVersion version,
java.lang.String longLabel,
java.lang.String shortLabel) |
Platform(PlatformType type,
PlatformVersion version,
java.lang.String longLabel,
java.lang.String shortLabel,
javax.swing.Icon icon) |
Platform(PlatformType type,
java.lang.String version) |
Platform(PlatformType type,
java.lang.String version,
java.lang.String longLabel,
java.lang.String shortLabel) |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(java.lang.Object o) |
boolean |
equals(java.lang.Object o) |
static Platform |
fromHashStructure(HashStructure hash)
Creates a Platform object from a
HashStructure representation. |
javax.swing.Icon |
getIcon()
Returns an
Icon that can be shown in association with this
Displayable . |
java.lang.String |
getLongLabel()
Returns a long label that can be displayed to the user.
|
java.lang.String |
getShortLabel()
Returns a short label that can be displayed to the user.
|
java.lang.String |
getToolTipText()
Returns the tool tip text to show when the mouse pointer pauses
over a UI component that represents this
Displayable . |
PlatformType |
getType() |
PlatformVersion |
getVersion() |
int |
hashCode() |
boolean |
supports(Platform other,
java.lang.Object[] features)
This method checks if a list of features implemented by the other Platform
are also supported by this Platform.
|
static HashStructure |
toHashStructure(Platform platform)
Convert a Platform object into a
HashStructure representation. |
java.lang.String |
toString()
Returns the Short Label displayed to a user.
|
public Platform(PlatformType type, PlatformVersion version, java.lang.String longLabel, java.lang.String shortLabel, javax.swing.Icon icon)
public Platform(PlatformType type, PlatformVersion version, java.lang.String longLabel, java.lang.String shortLabel)
public Platform(PlatformType type, java.lang.String version, java.lang.String longLabel, java.lang.String shortLabel)
public Platform(PlatformType type, PlatformVersion version)
public Platform(PlatformType type, java.lang.String version)
public static HashStructure toHashStructure(Platform platform)
HashStructure
representation.hash
- java.lang.NullPointerException
- if platform argument is null, or if
PlatformType or Version are not set.public static Platform fromHashStructure(HashStructure hash)
HashStructure
representation.hash
- java.lang.IllegalArgumentException
- if the hash is not recognized.public PlatformVersion getVersion()
public PlatformType getType()
public boolean supports(Platform other, java.lang.Object[] features)
other.suports(this, features)
may yield a different result.other
- the Platform to compare against.features
- array of features in the other Platform. Pass null to indicate all features.public java.lang.String toString()
Displayable
toString
method in java.lang.Object
.
Implementors of the Displayable
interface should
override this as appropriate. The default implementation is
the same as getShortLabel
toString
in interface Displayable
toString
in class java.lang.Object
Object.toString()
,
Displayable.getShortLabel()
public java.lang.String getShortLabel()
Displayable
String
is considered
translatable and should therefore be placed in an appropriate
resource file. When possible, the returned label should be
reasonably short enough to show in the navigator or explorer
windows but long enough to clearly identify and distinguish the
Displayable
.getShortLabel
in interface Displayable
Displayable
that can be shown to the user.public java.lang.String getLongLabel()
Displayable
String
is considered translatable
and should therefore be placed in an appropriate resource file.
The long label differs from the short label essentially on length.
Usually the long label will only be shown on-demand and in places
where horizontal space is more available. Examples are the status
bar and tooltips.getLongLabel
in interface Displayable
Displayable
that
can be shown to the user.public javax.swing.Icon getIcon()
Displayable
Icon
that can be shown in association with this
Displayable
. Typically the icon will be used in a
tree control or list control. Therefore the icon must fit
naturally within the space normally given to items within those
controls. Such icons are usually 16x16 in size or, if there is a
one-pixel transparent padding around the edge, 18x18 in size. It
is strongly recommended that icons returned by this method be
either 16x16 or 18x18 in size. If null
is returned,
the control may show a default icon, or it may show no icon,
whichever is appropriate.getIcon
in interface Displayable
Icon
to be displayed for the
Displayable
.public java.lang.String getToolTipText()
Displayable
Displayable
.
In many cases it may be appropriate for this method to return the
same value as Displayable.getLongLabel()
.getToolTipText
in interface Displayable
Displayable
.public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public int compareTo(java.lang.Object o)
compareTo
in interface java.lang.Comparable