org.gjt.universe
Class AtmosphereType

java.lang.Object
  |
  +--org.gjt.universe.Classification
        |
        +--org.gjt.universe.AtmosphereType
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
AtmosphereType.NoneAtmosphereType, AtmosphereType.NormalAtmosphereType

public class AtmosphereType
extends Classification

See Also:
Serialized Form

Nested Class Summary
static class AtmosphereType.NoneAtmosphereType
          This standard subclass is used to represent non-existent atmospheres (i.e.
static class AtmosphereType.NormalAtmosphereType
          This standard subclass is used to represent atmospheres which are much like that of Earth.
 
Field Summary
private static java.util.Vector allInstances
           
private  AtmosphereCompositionType myAtmosphereCompositionType
           
private  SurfacePressureType mySurfacePressureType
           
private  WeatherType myWeatherType
           
static AtmosphereType NONE
           
static AtmosphereType NORMAL
           
 
Fields inherited from class org.gjt.universe.Classification
 
Constructor Summary
protected AtmosphereType(java.lang.String aName, java.lang.String aBackStory, SurfacePressureType aSurfacePressureType, WeatherType aWeatherType, AtmosphereCompositionType aCompositionType)
          This constructor is used to construct instances of this class.
 
Method Summary
private static java.lang.String compositeName(SurfacePressureType aSurfacePressureType, WeatherType aWeatherType, AtmosphereCompositionType aCompositionType)
          This method returns the briefest possible name describing the particular collection of sub-classifications.
 AtmosphereCompositionType getAtmosphereCompositionType()
          This method returns the classification of the gasses that make-up the atmosphere.
 java.awt.Color getColor()
          This method returns a color that can be used to indicate the chemical composition of the atmosphere in a graphical user interface.
 SurfacePressureType getSurfacePressureType()
          This method returns the classification of the atmospheric surface pressure.
 WeatherType getWeatherType()
          This method returns the classification of the atmosphere's weather.
static AtmosphereType instanceForMakeup(SimpleAccrete.PlanetaryMakeup aMakeup)
          This class method returns the planet type instance which best matches the given planetary make-up.
static AtmosphereType sharedInstance(SurfacePressureType aSurfacePressureType, WeatherType aWeatherType, AtmosphereCompositionType aCompositionType)
          This method returns the shared instance which matches the given set of subclassifications, creating the new instance if necessary.
 
Methods inherited from class org.gjt.universe.Classification
getBackStory, getName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

allInstances

private static java.util.Vector allInstances

NORMAL

public static AtmosphereType NORMAL

NONE

public static AtmosphereType NONE

mySurfacePressureType

private SurfacePressureType mySurfacePressureType

myWeatherType

private WeatherType myWeatherType

myAtmosphereCompositionType

private AtmosphereCompositionType myAtmosphereCompositionType
Constructor Detail

AtmosphereType

protected AtmosphereType(java.lang.String aName,
                         java.lang.String aBackStory,
                         SurfacePressureType aSurfacePressureType,
                         WeatherType aWeatherType,
                         AtmosphereCompositionType aCompositionType)
This constructor is used to construct instances of this class. It should not be necessary for callers to invoke this directly, since all planet types should be created automatically.

Parameters:
aName - The short localized name of the planet type.
aBackStory - A localized description of the planet type.
Method Detail

instanceForMakeup

public static AtmosphereType instanceForMakeup(SimpleAccrete.PlanetaryMakeup aMakeup)
This class method returns the planet type instance which best matches the given planetary make-up.

Parameters:
aMakeup - A planetary make-up to be matched against.

sharedInstance

public static AtmosphereType sharedInstance(SurfacePressureType aSurfacePressureType,
                                            WeatherType aWeatherType,
                                            AtmosphereCompositionType aCompositionType)
This method returns the shared instance which matches the given set of subclassifications, creating the new instance if necessary.


compositeName

private static java.lang.String compositeName(SurfacePressureType aSurfacePressureType,
                                              WeatherType aWeatherType,
                                              AtmosphereCompositionType aCompositionType)
This method returns the briefest possible name describing the particular collection of sub-classifications.


getSurfacePressureType

public SurfacePressureType getSurfacePressureType()
This method returns the classification of the atmospheric surface pressure.


getWeatherType

public WeatherType getWeatherType()
This method returns the classification of the atmosphere's weather.


getAtmosphereCompositionType

public AtmosphereCompositionType getAtmosphereCompositionType()
This method returns the classification of the gasses that make-up the atmosphere.


getColor

public java.awt.Color getColor()
This method returns a color that can be used to indicate the chemical composition of the atmosphere in a graphical user interface.



Copyright © 2001 Universe Dev Team All Rights Reserved.