Argo (ArgoUML Javadoc for internal use)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.argouml.application.api
Class Argo

java.lang.Object
  org.argouml.application.api.Argo

public final class Argo
extends java.lang.Object
extends java.lang.Object

The Argo class provides static methods and definitions that can be used as helpers throughout the Argo code.

This class is a variation of the Expert design pattern [Grand]. By incorporating a number of unrelated but commonly used methods in a single class, it attempts to decrease the complexity of the overall code while increasing its own complexity.

These include

definitions of configuration keys
definitions of resource bundle identifier strings
methods for localization using gef
methods for environment manipulation

Field Summary
`static java.lang.String`	`ARGO_CONSOLE_PREFIX` Standard definition of system variable to add text prefix to console log.
`static java.lang.String`	`ARGO_CONSOLE_SUPPRESS` Standard definition of the logging category for the console.
`static java.lang.String`	`ARGOINI` Deprecated. for 0.25.4 by tfmorris. No longer used.
`static java.lang.String`	`AUTHOR_TAG` Name of the TagDefinition for tagged values containing the author's name.
`static java.lang.String`	`CONSOLE_LOG` Standard definition of the logging category for the console.
`static java.lang.String`	`DEPRECATED_TAG` Name of the TagDefinition for tagged values containing deprecated flag.
`static java.lang.String`	`DOCUMENTATION_TAG` Name of the TagDefinition which is used as the type of tagged values containing documentation for a model element.
`static java.lang.String`	`DOCUMENTATION_TAG_ALT` Deprecated. for 0.25.1 by tfmorris - don't use for new code.
`static ConfigurationKey`	`KEY_DEFAULT_MODEL` Key to store profile/default model.
`static ConfigurationKey`	`KEY_EDEM` Key to report usage statistics.
`static ConfigurationKey`	`KEY_GRID` Key for selecting the grid size and if it shows lines, dots or none.
`static ConfigurationKey`	`KEY_IMPORT_GENERAL_DETAIL_LEVEL` Key for RE general settings: level of import detail.
`static ConfigurationKey`	`KEY_IMPORT_GENERAL_SETTINGS_FLAGS` Key for RE general settings checkbox values.
`static ConfigurationKey`	`KEY_INPUT_SOURCE_ENCODING` Key for input source file encoding used in RE.
`static ConfigurationKey`	`KEY_LOCALE` Key for selecting the locale.
`static ConfigurationKey`	`KEY_LOOK_AND_FEEL_CLASS` Key for look and feel class name.
`static ConfigurationKey`	`KEY_MOST_RECENT_EXPORT_DIRECTORY` Key for last generated class/classes directory.
`static ConfigurationKey`	`KEY_MOST_RECENT_PROJECT_FILE` Key for last saved project URI.
`static ConfigurationKey`	`KEY_NUMBER_LAST_RECENT_USED` Key for number of last recently used file entries in menu list.
`static ConfigurationKey`	`KEY_RELOAD_RECENT_PROJECT` Key to reload last saved project on startup.
`static ConfigurationKey`	`KEY_SCREEN_EAST_WIDTH` Key for east pane width.
`static ConfigurationKey`	`KEY_SCREEN_HEIGHT` Key for screen height.
`static ConfigurationKey`	`KEY_SCREEN_LEFT_X` Key for screen left.
`static ConfigurationKey`	`KEY_SCREEN_MAXIMIZED` Key for screen extended state, i.e.
`static ConfigurationKey`	`KEY_SCREEN_NORTH_HEIGHT` Key for north pane height.
`static ConfigurationKey`	`KEY_SCREEN_NORTHEAST_WIDTH` Key for northeast pane width.
`static ConfigurationKey`	`KEY_SCREEN_NORTHWEST_WIDTH` Key for northwest pane width.
`static ConfigurationKey`	`KEY_SCREEN_SOUTH_HEIGHT` Key for south pane height.
`static ConfigurationKey`	`KEY_SCREEN_SOUTHEAST_WIDTH` Key for southeast pane width.
`static ConfigurationKey`	`KEY_SCREEN_SOUTHWEST_WIDTH` Key for southwest pane width.
`static ConfigurationKey`	`KEY_SCREEN_THEME` Key for theme.
`static ConfigurationKey`	`KEY_SCREEN_TOP_Y` Key for screen top.
`static ConfigurationKey`	`KEY_SCREEN_WEST_WIDTH` Key for west pane width.
`static ConfigurationKey`	`KEY_SCREEN_WIDTH` Key for screen width.
`static ConfigurationKey`	`KEY_SMOOTH_EDGES` Key to enable smooth edges of diagram text and lines (anti-aliasing).
`static ConfigurationKey`	`KEY_SNAP` Key for selecting the snap size.
`static ConfigurationKey`	`KEY_SPLASH` Key to show splash screen.
`static ConfigurationKey`	`KEY_STARTUP_DIR` Key for default startup directory.
`static ConfigurationKey`	`KEY_THEME_CLASS` Key for theme class name.
`static ConfigurationKey`	`KEY_USER_EMAIL` Key for user email address.
`static ConfigurationKey`	`KEY_USER_EXPLORER_PERSPECTIVES` Key for user explorer perspectives.
`static ConfigurationKey`	`KEY_USER_FULLNAME` Key for user full name.
`static ConfigurationKey`	`KEY_USER_IMPORT_CLASSPATH` Key for user java reverse engineering classpath.
`static ConfigurationKey`	`KEY_XMI_STRIP_DIAGRAMS` Key to store setting of stripping diagrams on XMI import.
`static int`	`SCOPE_APPLICATION` The scope of the settings: this setting is stored in the userdirectory and valid for the application.
`static int`	`SCOPE_PROJECT` The scope of the setting: this setting is stored with the project, i.e.
`static java.lang.String`	`SEE_TAG` Name of the TagDefinition for tagged values containing "see" reference.
`static java.lang.String`	`SINCE_TAG` Name of the TagDefinition for tagged values containing since date.
`static java.lang.String`	`VERSION_TAG` Name of the TagDefinition for tagged values containing version string.

Method Summary
`static java.lang.String`	`getDirectory()` Get the default startup directory.
`static java.lang.String`	`getEncoding()` Supply the encoding to be used throughout the persistence mechanism.
`static void`	`setDirectory(java.lang.String dir)` Change the default startup directory.

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

Field Detail

ARGOINI

@Deprecated
public static final java.lang.String ARGOINI

Deprecated. for 0.25.4 by tfmorris. No longer used.

argo.ini path.

See Also:: Constant Field Values

KEY_STARTUP_DIR

public static final ConfigurationKey KEY_STARTUP_DIR

Key for default startup directory.

KEY_SPLASH

public static final ConfigurationKey KEY_SPLASH

Key to show splash screen.

KEY_EDEM

public static final ConfigurationKey KEY_EDEM

Key to report usage statistics.

KEY_MOST_RECENT_PROJECT_FILE

public static final ConfigurationKey KEY_MOST_RECENT_PROJECT_FILE

Key for last saved project URI.

KEY_MOST_RECENT_EXPORT_DIRECTORY

public static final ConfigurationKey KEY_MOST_RECENT_EXPORT_DIRECTORY

Key for last generated class/classes directory.

KEY_RELOAD_RECENT_PROJECT

public static final ConfigurationKey KEY_RELOAD_RECENT_PROJECT

Key to reload last saved project on startup.

KEY_NUMBER_LAST_RECENT_USED

public static final ConfigurationKey KEY_NUMBER_LAST_RECENT_USED

Key for number of last recently used file entries in menu list.

KEY_SCREEN_TOP_Y

public static final ConfigurationKey KEY_SCREEN_TOP_Y

Key for screen top.

KEY_SCREEN_LEFT_X

public static final ConfigurationKey KEY_SCREEN_LEFT_X

Key for screen left.

KEY_SCREEN_WIDTH

public static final ConfigurationKey KEY_SCREEN_WIDTH

Key for screen width.

KEY_SCREEN_HEIGHT

public static final ConfigurationKey KEY_SCREEN_HEIGHT

Key for screen height.

KEY_SCREEN_MAXIMIZED

public static final ConfigurationKey KEY_SCREEN_MAXIMIZED

Key for screen extended state, i.e. NORMAL, MAXIMIZED; (see Frame documentation).

KEY_SCREEN_SOUTHWEST_WIDTH

public static final ConfigurationKey KEY_SCREEN_SOUTHWEST_WIDTH

Key for southwest pane width.

KEY_SCREEN_NORTHWEST_WIDTH

public static final ConfigurationKey KEY_SCREEN_NORTHWEST_WIDTH

Key for northwest pane width.

KEY_SCREEN_SOUTHEAST_WIDTH

public static final ConfigurationKey KEY_SCREEN_SOUTHEAST_WIDTH

Key for southeast pane width.

KEY_SCREEN_NORTHEAST_WIDTH

public static final ConfigurationKey KEY_SCREEN_NORTHEAST_WIDTH

Key for northeast pane width.

KEY_SCREEN_WEST_WIDTH

public static final ConfigurationKey KEY_SCREEN_WEST_WIDTH

Key for west pane width.

KEY_SCREEN_EAST_WIDTH

public static final ConfigurationKey KEY_SCREEN_EAST_WIDTH

Key for east pane width.

KEY_SCREEN_SOUTH_HEIGHT

public static final ConfigurationKey KEY_SCREEN_SOUTH_HEIGHT

Key for south pane height.

KEY_SCREEN_NORTH_HEIGHT

public static final ConfigurationKey KEY_SCREEN_NORTH_HEIGHT

Key for north pane height.

KEY_SCREEN_THEME

public static final ConfigurationKey KEY_SCREEN_THEME

Key for theme.

KEY_LOOK_AND_FEEL_CLASS

public static final ConfigurationKey KEY_LOOK_AND_FEEL_CLASS

Key for look and feel class name.

KEY_THEME_CLASS

public static final ConfigurationKey KEY_THEME_CLASS

Key for theme class name.

KEY_SMOOTH_EDGES

public static final ConfigurationKey KEY_SMOOTH_EDGES

Key to enable smooth edges of diagram text and lines (anti-aliasing).

KEY_USER_EMAIL

public static final ConfigurationKey KEY_USER_EMAIL

Key for user email address.

KEY_USER_FULLNAME

public static final ConfigurationKey KEY_USER_FULLNAME

Key for user full name.

KEY_USER_IMPORT_CLASSPATH

public static final ConfigurationKey KEY_USER_IMPORT_CLASSPATH

Key for user java reverse engineering classpath.

KEY_IMPORT_GENERAL_SETTINGS_FLAGS

public static final ConfigurationKey KEY_IMPORT_GENERAL_SETTINGS_FLAGS

Key for RE general settings checkbox values. CSV format (values are true/false): 1. descend directories recursively 2. changed/new files only 3. create diagrams from imported code 4. minimise class icons in diagrams 5. perform automatic diagram layout

KEY_IMPORT_GENERAL_DETAIL_LEVEL

public static final ConfigurationKey KEY_IMPORT_GENERAL_DETAIL_LEVEL

Key for RE general settings: level of import detail. Values: 0: classifiers only 1: classifiers plus feature specifications 2: full import

KEY_INPUT_SOURCE_ENCODING

public static final ConfigurationKey KEY_INPUT_SOURCE_ENCODING

Key for input source file encoding used in RE. Will be used for generated file also.

KEY_XMI_STRIP_DIAGRAMS

public static final ConfigurationKey KEY_XMI_STRIP_DIAGRAMS

Key to store setting of stripping diagrams on XMI import.

KEY_DEFAULT_MODEL

public static final ConfigurationKey KEY_DEFAULT_MODEL

Key to store profile/default model.

KEY_USER_EXPLORER_PERSPECTIVES

public static final ConfigurationKey KEY_USER_EXPLORER_PERSPECTIVES

Key for user explorer perspectives.

 format:
 perspective name,rule,rule,rule;perspective name, etc

KEY_LOCALE

public static final ConfigurationKey KEY_LOCALE

Key for selecting the locale.

KEY_GRID

public static final ConfigurationKey KEY_GRID

Key for selecting the grid size and if it shows lines, dots or none.

KEY_SNAP

public static final ConfigurationKey KEY_SNAP

Key for selecting the snap size.

CONSOLE_LOG

public static final java.lang.String CONSOLE_LOG

Standard definition of the logging category for the console. (unused)

See Also:: Constant Field Values

ARGO_CONSOLE_SUPPRESS

public static final java.lang.String ARGO_CONSOLE_SUPPRESS

Standard definition of the logging category for the console.

See Also:: Constant Field Values

ARGO_CONSOLE_PREFIX

public static final java.lang.String ARGO_CONSOLE_PREFIX

Standard definition of system variable to add text prefix to console log. (unused)

See Also:: Constant Field Values

DOCUMENTATION_TAG

public static final java.lang.String DOCUMENTATION_TAG

Name of the TagDefinition which is used as the type of tagged values containing documentation for a model element.

See Also:: Constant Field Values

AUTHOR_TAG

public static final java.lang.String AUTHOR_TAG

Name of the TagDefinition for tagged values containing the author's name.

See Also:: Constant Field Values

SINCE_TAG

public static final java.lang.String SINCE_TAG

Name of the TagDefinition for tagged values containing since date.

See Also:: Constant Field Values

SEE_TAG

public static final java.lang.String SEE_TAG

Name of the TagDefinition for tagged values containing "see" reference.

See Also:: Constant Field Values

DEPRECATED_TAG

public static final java.lang.String DEPRECATED_TAG

Name of the TagDefinition for tagged values containing deprecated flag.

See Also:: Constant Field Values

VERSION_TAG

public static final java.lang.String VERSION_TAG

Name of the TagDefinition for tagged values containing version string.

See Also:: Constant Field Values

DOCUMENTATION_TAG_ALT

@Deprecated
public static final java.lang.String DOCUMENTATION_TAG_ALT

Deprecated. for 0.25.1 by tfmorris - don't use for new code.

Alternate name for the TagDefinition which presumably was used at some point in the past to contain documentation for a model element. Only used for backward compatibilty.

See Also:: Constant Field Values

SCOPE_APPLICATION

public static final int SCOPE_APPLICATION

The scope of the settings: this setting is stored in the userdirectory and valid for the application.

See Also:: Constant Field Values

SCOPE_PROJECT

public static final int SCOPE_PROJECT

The scope of the setting: this setting is stored with the project, i.e. in e.g. a zargo file. This setting will also apply when the zargo file is opened by another user, on another computer.

See Also:: Constant Field Values

Method Detail

setDirectory

public static void setDirectory(java.lang.String dir)

Change the default startup directory.

Parameters:: dir - the directory to save

getDirectory

public static java.lang.String getDirectory()

Get the default startup directory.

Returns:: the startup directory

getEncoding

public static java.lang.String getEncoding()

Supply the encoding to be used throughout the persistence mechanism.

Returns:: the encoding.