org.azyva.dragom.util

Class Util

java.lang.Object

org.azyva.dragom.util.Util

public final class Util
extends Object

Static utility methods. For now this class is a mixed bag of utility methods. With time and maturity some groups of utility methods may be migrated to separate classes.

Author:

David Raymond

Field Summary

Fields

Modifier and Type	Field and Description
static String	DO_YOU_WANT_TO_CONTINUE_CONTEXT_COMMIT Context for handleDoYouWantToContinue(java.lang.String) that represents committing local unsynchronized changes.
static String	DO_YOU_WANT_TO_CONTINUE_CONTEXT_COMMIT_REFERENCE_CHANGE_AFTER_ABORT Context for handleDoYouWantToContinue(java.lang.String) that represents the fact that during the creation of a static Version or the switch to a dynamic Version one or more references were changed but not committed and the user requested to abort.
static String	DO_YOU_WANT_TO_CONTINUE_CONTEXT_CREATE_DYNAMIC_VERSION Context for handleDoYouWantToContinue(java.lang.String) that represents creating a new dynamic Version.
static String	DO_YOU_WANT_TO_CONTINUE_CONTEXT_CREATE_STATIC_VERSION Context for handleDoYouWantToContinue(java.lang.String) that represents creating a new static Version.
static String	DO_YOU_WANT_TO_CONTINUE_CONTEXT_DELETE_WORKSPACE_DIRECTORY Context for handleDoYouWantToContinue(java.lang.String) that represents deleting a workspace directory (not containing any unsynchronized local changes).
static String	DO_YOU_WANT_TO_CONTINUE_CONTEXT_DELETE_WORKSPACE_DIRECTORY_WITH_UNSYNC_LOCAL_CHANGES Context for handleDoYouWantToContinue(java.lang.String) that represents deleting a workspace directory containing un synchronized changes.
static String	DO_YOU_WANT_TO_CONTINUE_CONTEXT_MAY_LOOSE_COMMITS Context for handleDoYouWantToContinue(java.lang.String) that represents the fact that following the selection of a new dynamic Version during a merge (MergeReferenceGraph) diverging commits in the destination are not present in the new selected dynamic Version and may be lost.
static String	DO_YOU_WANT_TO_CONTINUE_CONTEXT_MERGE Context for handleDoYouWantToContinue(java.lang.String) that represents merging a Version into another.
static String	DO_YOU_WANT_TO_CONTINUE_CONTEXT_NON_STATIC_VERSIONS_REFERENCE_PATH Context for handleDoYouWantToContinue(java.lang.String) that represents the fact that during the switch to a hotfix dynamic Version, the ReferencePath contains non-static Versions.
static String	DO_YOU_WANT_TO_CONTINUE_CONTEXT_REFERENCE_CHANGE_AFTER_SWITCHING Context for handleDoYouWantToContinue(java.lang.String) that represents reference change after switching to a dynamic Version.
static String	DO_YOU_WANT_TO_CONTINUE_CONTEXT_SWITCH_WITH_UNSYNC_LOCAL_CHANGES Context for handleDoYouWantToContinue(java.lang.String) that represents the fact that local changes exist in a workspace directory and switching to a new Version is not possible.
static String	DO_YOU_WANT_TO_CONTINUE_CONTEXT_UNSYNC_REMOTE_CHANGES_WHILE_COMMIT Context for handleDoYouWantToContinue(java.lang.String) that represents having unsynchronized remote changes while committing.
static String	DO_YOU_WANT_TO_CONTINUE_CONTEXT_UPDATE_REFERENCE Context for handleDoYouWantToContinue(java.lang.String) that represents updating a reference.
static String	DO_YOU_WANT_TO_CONTINUE_CONTEXT_USE_CURRENT_HOTFIX_VERSION Context for handleDoYouWantToContinue(java.lang.String) that represents the fact that during the switch to a hotfix dynamic Version, the ReferencePath contains non-static Versions.
static String	MSG_PATTERN_DO_YOU_WANT_TO_CONTINUE See description in ResourceBundle.
static String	MSG_PATTERN_KEY_ALWAYS_NEVER_ASK_RESPONSE_CHOICES See description in ResourceBundle.
static String	MSG_PATTERN_KEY_ALWAYS_NEVER_YES_NO_ASK_RESPONSE_CHOICES See description in ResourceBundle.
static String	MSG_PATTERN_KEY_ALWAYS_RESPONSE See description in ResourceBundle.
static String	MSG_PATTERN_KEY_ASK_RESPONSE See description in ResourceBundle.
static String	MSG_PATTERN_KEY_INCORRECT_VERSION_TYPE See description in ResourceBundle.
static String	MSG_PATTERN_KEY_INVALID_RESPONSE_TRY_AGAIN See description in ResourceBundle.
static String	MSG_PATTERN_KEY_JOB_ABORTED_BY_USER See description in ResourceBundle.
static String	MSG_PATTERN_KEY_JOB_COMPLETED See description in ResourceBundle.
static String	MSG_PATTERN_KEY_NEVER_RESPONSE See description in ResourceBundle.
static String	MSG_PATTERN_KEY_NO_ABORT_RESPONSE See description in ResourceBundle.
static String	MSG_PATTERN_KEY_NO_ASK_RESPONSE See description in ResourceBundle.
static String	MSG_PATTERN_KEY_NO_RESPONSE See description in ResourceBundle.
static String	MSG_PATTERN_KEY_PREVIOUS_CHANGE_COMMITTED_SCM See description in ResourceBundle.
static String	MSG_PATTERN_KEY_PREVIOUS_CHANGE_SCM See description in ResourceBundle.
static String	MSG_PATTERN_KEY_STARTING_JOB See description in ResourceBundle.
static String	MSG_PATTERN_KEY_TRY_AGAIN See description in ResourceBundle.
static String	MSG_PATTERN_KEY_VERSION_DOES_NOT_EXIST See description in ResourceBundle.
static String	MSG_PATTERN_KEY_VERSION_FORMAT_HELP See description in ResourceBundle.
static String	MSG_PATTERN_KEY_VERSION_FORMAT_HELP_VERSION_MUST_EXIST See description in ResourceBundle.
static String	MSG_PATTERN_KEY_WORKSPACE_DIRECTORY_NOT_SYNC See description in ResourceBundle.
static String	MSG_PATTERN_KEY_YES_ALWAYS_NO_ABORT_RESPONSE_CHOICES See description in ResourceBundle.
static String	MSG_PATTERN_KEY_YES_ALWAYS_NO_RESPONSE_CHOICES See description in ResourceBundle.
static String	MSG_PATTERN_KEY_YES_ALWAYS_RESPONSE See description in ResourceBundle.
static String	MSG_PATTERN_KEY_YES_ASK_RESPONSE See description in ResourceBundle.
static String	MSG_PATTERN_KEY_YES_NO_RESPONSE_CHOICES See description in ResourceBundle.
static String	MSG_PATTERN_KEY_YES_RESPONSE See description in ResourceBundle.
static String	RUNTIME_PROPERTY_IND_ABORT Runtime property indicating to abort.
static String	RUNTIME_PROPERTY_IND_NO_CONFIRM Runtime property specifying whether confirmation is required.

Constructor Summary

Constructors

Constructor and Description
Util()

Method Summary

Modifier and Type	Method and Description
static void	applyDragomSystemProperties() Applies system properties from the META-INF/dragom.properties classpath resource.
static String	convertPascalCaseToLowercaseWithDashes(String stringPascalCase) Converts a PascalCase (or camelCase) string to lowercase with dashes.
static String	getCommitMessageWithoutAttr(String commitMessage) Helper method to remove commit attributes from a commit message.
static Class<? extends org.azyva.dragom.model.plugin.NodePlugin>	getDefaultClassNodePlugin(String pluginClass) Returns the default NodePlugin interface for a plugin implementation class.
static String	getDefaultPluginId(Class<? extends org.azyva.dragom.model.plugin.NodePlugin> classNodePlugin, String pluginClass) Returns the default plugin ID for NodePlugin interface supported by a plugin implementation class.
static AlwaysNeverAskUserResponse	getInfoAlwaysNeverAskUserResponse(org.azyva.dragom.execcontext.plugin.UserInteractionCallbackPlugin userInteractionCallbackPlugin, String prompt, AlwaysNeverAskUserResponse alwaysNeverAskUserResponseDefaultValue) Facilitates letting the user input a AlwaysNeverAskUserResponse.
static AlwaysNeverAskUserResponse	getInfoAlwaysNeverAskUserResponseAndHandleAsk(org.azyva.dragom.execcontext.plugin.RuntimePropertiesPlugin runtimePropertiesPlugin, String runtimeProperty, org.azyva.dragom.execcontext.plugin.UserInteractionCallbackPlugin userInteractionCallbackPlugin, String prompt) This is an extension to the method getInfoAlwaysNeverAskUserResponse that handles storing the user response in a runtime property.
static AlwaysNeverYesNoAskUserResponse	getInfoAlwaysNeverYesNoAskUserResponse(org.azyva.dragom.execcontext.plugin.UserInteractionCallbackPlugin userInteractionCallbackPlugin, String prompt, AlwaysNeverYesNoAskUserResponse alwaysNeverYesNoAskUserResponseDefaultValue) Facilitates letting the user input a AlwaysNeverYesNoAskUserResponse.
static AlwaysNeverYesNoAskUserResponse	getInfoAlwaysNeverYesNoAskUserResponseAndHandleAsk(org.azyva.dragom.execcontext.plugin.RuntimePropertiesPlugin runtimePropertiesPlugin, String runtimeProperty, org.azyva.dragom.execcontext.plugin.UserInteractionCallbackPlugin userInteractionCallbackPlugin, String prompt) This is an extension to the method getInfoAlwaysNeverYesNoAskUserResponse that handles storing the user response in a runtime property.
static org.azyva.dragom.model.Version	getInfoVersion(org.azyva.dragom.model.VersionType versionType, org.azyva.dragom.model.plugin.ScmPlugin scmPlugin, org.azyva.dragom.execcontext.plugin.UserInteractionCallbackPlugin userInteractionCallbackPlugin, String prompt, org.azyva.dragom.model.Version versionDefaultValue) Facilitates letting the user input a Version.
static YesAlwaysNoUserResponse	getInfoYesAlwaysNoAbortUserResponse(org.azyva.dragom.execcontext.plugin.UserInteractionCallbackPlugin userInteractionCallbackPlugin, String prompt, YesAlwaysNoUserResponse yesAlwaysNoUserResponseDefaultValue) Facilitates letting the user input a YesAlwaysNoUserResponse with support for "no" and "abort" responses.
static YesAlwaysNoUserResponse	getInfoYesAlwaysNoUserResponse(org.azyva.dragom.execcontext.plugin.UserInteractionCallbackPlugin userInteractionCallbackPlugin, String prompt, YesAlwaysNoUserResponse yesAlwaysNoUserResponseDefaultValue) Facilitates letting the user input a YesAlwaysNoUserResponse.
static YesAlwaysNoUserResponse	getInfoYesNoUserResponse(org.azyva.dragom.execcontext.plugin.UserInteractionCallbackPlugin userInteractionCallbackPlugin, String prompt, YesAlwaysNoUserResponse yesAlwaysNoUserResponseDefaultValue) This method is very similar to getInfoYesAlwaysNoUserResponse except that it does not support the "Always" response.
static Map<String,String>	getJsonAttr(String message, Map<String,String> mapAttr) Helper method to retrieve attributes from a message.
static String	getLocalizedMsgPattern(String msgPatternKey)
static org.azyva.dragom.model.plugin.NodePluginFactory	getNodePluginFactory(String stringClassNodePlugin) Gets an instance of NodePluginFactory for a plugin implementation class.
static boolean	handleDoYouWantToContinue(String context) Helper method that handles generically the typical question "Do you want to continue?".
static boolean	handleDoYouWantToContinueWithIndividualNo(String context) Helper method that handles generically the typical question "Do you want to continue?".
static String	inferGroupIdSegmentFromNodePath(org.azyva.dragom.model.NodePath nodePath) Infers a groupId segment from a module node path.
static boolean	isAbort()
static boolean	isDigits(String string) Verifies if a String contains only ASCII digits.
static boolean	isDirectoryEmpty(Path path)
static boolean	isNotNullAndTrue(Boolean aBoolean) Facilitates interpreting Boolean objects.
static boolean	isNotNullAndTrue(String stringBoolean) Facilitates interpreting Boolean objects.
static boolean	isPosix()
static boolean	isWindows()
static void	setAbort() Sets the IND_ABORT runtime property explicitly.
static String	spaces(int length) Returns a string of length spaces.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RUNTIME_PROPERTY_IND_NO_CONFIRM

public static final String RUNTIME_PROPERTY_IND_NO_CONFIRM

Runtime property specifying whether confirmation is required.

If used as a prefix with ".<context>" as a suffix, it specifies whether confirmation is required for that particular context.

See Also:

Constant Field Values

RUNTIME_PROPERTY_IND_ABORT

public static final String RUNTIME_PROPERTY_IND_ABORT

Runtime property indicating to abort.

Being a runtime property it can be set at different levels before tool execution, but this would not be useful as it would indicate to abort the tool immediately. If is expected to be set only within the code.

See Also:

Constant Field Values

DO_YOU_WANT_TO_CONTINUE_CONTEXT_UPDATE_REFERENCE

public static final String DO_YOU_WANT_TO_CONTINUE_CONTEXT_UPDATE_REFERENCE

Context for handleDoYouWantToContinue(java.lang.String) that represents updating a reference.

See Also:

Constant Field Values

DO_YOU_WANT_TO_CONTINUE_CONTEXT_CREATE_STATIC_VERSION

public static final String DO_YOU_WANT_TO_CONTINUE_CONTEXT_CREATE_STATIC_VERSION

Context for handleDoYouWantToContinue(java.lang.String) that represents creating a new static Version.

See Also:

Constant Field Values

DO_YOU_WANT_TO_CONTINUE_CONTEXT_CREATE_DYNAMIC_VERSION

public static final String DO_YOU_WANT_TO_CONTINUE_CONTEXT_CREATE_DYNAMIC_VERSION

Context for handleDoYouWantToContinue(java.lang.String) that represents creating a new dynamic Version.

See Also:

Constant Field Values

DO_YOU_WANT_TO_CONTINUE_CONTEXT_MERGE

public static final String DO_YOU_WANT_TO_CONTINUE_CONTEXT_MERGE

Context for handleDoYouWantToContinue(java.lang.String) that represents merging a Version into another.

See Also:

Constant Field Values

DO_YOU_WANT_TO_CONTINUE_CONTEXT_REFERENCE_CHANGE_AFTER_SWITCHING

public static final String DO_YOU_WANT_TO_CONTINUE_CONTEXT_REFERENCE_CHANGE_AFTER_SWITCHING

Context for handleDoYouWantToContinue(java.lang.String) that represents reference change after switching to a dynamic Version.

See Also:

Constant Field Values

DO_YOU_WANT_TO_CONTINUE_CONTEXT_COMMIT

public static final String DO_YOU_WANT_TO_CONTINUE_CONTEXT_COMMIT

Context for handleDoYouWantToContinue(java.lang.String) that represents committing local unsynchronized changes.

See Also:

Constant Field Values

DO_YOU_WANT_TO_CONTINUE_CONTEXT_UNSYNC_REMOTE_CHANGES_WHILE_COMMIT

public static final String DO_YOU_WANT_TO_CONTINUE_CONTEXT_UNSYNC_REMOTE_CHANGES_WHILE_COMMIT

Context for handleDoYouWantToContinue(java.lang.String) that represents having unsynchronized remote changes while committing.

See Also:

Constant Field Values

DO_YOU_WANT_TO_CONTINUE_CONTEXT_DELETE_WORKSPACE_DIRECTORY_WITH_UNSYNC_LOCAL_CHANGES

public static final String DO_YOU_WANT_TO_CONTINUE_CONTEXT_DELETE_WORKSPACE_DIRECTORY_WITH_UNSYNC_LOCAL_CHANGES

Context for handleDoYouWantToContinue(java.lang.String) that represents deleting a workspace directory containing un synchronized changes.

See Also:

Constant Field Values

DO_YOU_WANT_TO_CONTINUE_CONTEXT_DELETE_WORKSPACE_DIRECTORY

public static final String DO_YOU_WANT_TO_CONTINUE_CONTEXT_DELETE_WORKSPACE_DIRECTORY

Context for handleDoYouWantToContinue(java.lang.String) that represents deleting a workspace directory (not containing any unsynchronized local changes).

See Also:

Constant Field Values

DO_YOU_WANT_TO_CONTINUE_CONTEXT_MAY_LOOSE_COMMITS

public static final String DO_YOU_WANT_TO_CONTINUE_CONTEXT_MAY_LOOSE_COMMITS

Context for handleDoYouWantToContinue(java.lang.String) that represents the fact that following the selection of a new dynamic Version during a merge (MergeReferenceGraph) diverging commits in the destination are not present in the new selected dynamic Version and may be lost.

See Also:

Constant Field Values

DO_YOU_WANT_TO_CONTINUE_CONTEXT_SWITCH_WITH_UNSYNC_LOCAL_CHANGES

public static final String DO_YOU_WANT_TO_CONTINUE_CONTEXT_SWITCH_WITH_UNSYNC_LOCAL_CHANGES

Context for handleDoYouWantToContinue(java.lang.String) that represents the fact that local changes exist in a workspace directory and switching to a new Version is not possible. Continuing here means to continue with the other ModuleVersion.

See Also:

Constant Field Values

DO_YOU_WANT_TO_CONTINUE_CONTEXT_NON_STATIC_VERSIONS_REFERENCE_PATH

public static final String DO_YOU_WANT_TO_CONTINUE_CONTEXT_NON_STATIC_VERSIONS_REFERENCE_PATH

Context for handleDoYouWantToContinue(java.lang.String) that represents the fact that during the switch to a hotfix dynamic Version, the ReferencePath contains non-static Versions. which may be OK if they were created in the context of the hotfix.

See Also:

Constant Field Values

DO_YOU_WANT_TO_CONTINUE_CONTEXT_USE_CURRENT_HOTFIX_VERSION

public static final String DO_YOU_WANT_TO_CONTINUE_CONTEXT_USE_CURRENT_HOTFIX_VERSION

Context for handleDoYouWantToContinue(java.lang.String) that represents the fact that during the switch to a hotfix dynamic Version, the ReferencePath contains non-static Versions. which may be OK if they were created in the context of the hotfix.

See Also:

Constant Field Values

DO_YOU_WANT_TO_CONTINUE_CONTEXT_COMMIT_REFERENCE_CHANGE_AFTER_ABORT

public static final String DO_YOU_WANT_TO_CONTINUE_CONTEXT_COMMIT_REFERENCE_CHANGE_AFTER_ABORT

Context for handleDoYouWantToContinue(java.lang.String) that represents the fact that during the creation of a static Version or the switch to a dynamic Version one or more references were changed but not committed and the user requested to abort. Should the commit be performed in that case?

See Also:

Constant Field Values

MSG_PATTERN_KEY_ALWAYS_NEVER_ASK_RESPONSE_CHOICES

public static final String MSG_PATTERN_KEY_ALWAYS_NEVER_ASK_RESPONSE_CHOICES

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_ALWAYS_RESPONSE

public static final String MSG_PATTERN_KEY_ALWAYS_RESPONSE

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_NEVER_RESPONSE

public static final String MSG_PATTERN_KEY_NEVER_RESPONSE

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_ASK_RESPONSE

public static final String MSG_PATTERN_KEY_ASK_RESPONSE

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_ALWAYS_NEVER_YES_NO_ASK_RESPONSE_CHOICES

public static final String MSG_PATTERN_KEY_ALWAYS_NEVER_YES_NO_ASK_RESPONSE_CHOICES

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_YES_ASK_RESPONSE

public static final String MSG_PATTERN_KEY_YES_ASK_RESPONSE

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_NO_ASK_RESPONSE

public static final String MSG_PATTERN_KEY_NO_ASK_RESPONSE

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_YES_ALWAYS_NO_RESPONSE_CHOICES

public static final String MSG_PATTERN_KEY_YES_ALWAYS_NO_RESPONSE_CHOICES

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_YES_RESPONSE

public static final String MSG_PATTERN_KEY_YES_RESPONSE

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_YES_ALWAYS_RESPONSE

public static final String MSG_PATTERN_KEY_YES_ALWAYS_RESPONSE

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_NO_RESPONSE

public static final String MSG_PATTERN_KEY_NO_RESPONSE

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_YES_ALWAYS_NO_ABORT_RESPONSE_CHOICES

public static final String MSG_PATTERN_KEY_YES_ALWAYS_NO_ABORT_RESPONSE_CHOICES

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_NO_ABORT_RESPONSE

public static final String MSG_PATTERN_KEY_NO_ABORT_RESPONSE

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_YES_NO_RESPONSE_CHOICES

public static final String MSG_PATTERN_KEY_YES_NO_RESPONSE_CHOICES

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_INVALID_RESPONSE_TRY_AGAIN

public static final String MSG_PATTERN_KEY_INVALID_RESPONSE_TRY_AGAIN

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_VERSION_FORMAT_HELP

public static final String MSG_PATTERN_KEY_VERSION_FORMAT_HELP

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_VERSION_FORMAT_HELP_VERSION_MUST_EXIST

public static final String MSG_PATTERN_KEY_VERSION_FORMAT_HELP_VERSION_MUST_EXIST

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_INCORRECT_VERSION_TYPE

public static final String MSG_PATTERN_KEY_INCORRECT_VERSION_TYPE

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_VERSION_DOES_NOT_EXIST

public static final String MSG_PATTERN_KEY_VERSION_DOES_NOT_EXIST

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_TRY_AGAIN

public static final String MSG_PATTERN_KEY_TRY_AGAIN

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_DO_YOU_WANT_TO_CONTINUE

public static final String MSG_PATTERN_DO_YOU_WANT_TO_CONTINUE

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_STARTING_JOB

public static final String MSG_PATTERN_KEY_STARTING_JOB

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_JOB_COMPLETED

public static final String MSG_PATTERN_KEY_JOB_COMPLETED

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_JOB_ABORTED_BY_USER

public static final String MSG_PATTERN_KEY_JOB_ABORTED_BY_USER

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_WORKSPACE_DIRECTORY_NOT_SYNC

public static final String MSG_PATTERN_KEY_WORKSPACE_DIRECTORY_NOT_SYNC

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_PREVIOUS_CHANGE_COMMITTED_SCM

public static final String MSG_PATTERN_KEY_PREVIOUS_CHANGE_COMMITTED_SCM

See description in ResourceBundle.

See Also:

Constant Field Values

MSG_PATTERN_KEY_PREVIOUS_CHANGE_SCM

public static final String MSG_PATTERN_KEY_PREVIOUS_CHANGE_SCM

See description in ResourceBundle.

See Also:

Constant Field Values

Constructor Detail

Util

public Util()

Method Detail

inferGroupIdSegmentFromNodePath

public static String inferGroupIdSegmentFromNodePath(org.azyva.dragom.model.NodePath nodePath)

Infers a groupId segment from a module node path.

We talk about the groupId segment since a complete groupId will generally be some prefix plus a "." to which the value returned is appended.

If the NodePath is not partial (see NodePath.isPartial), meaning that it refers to a Module and not a ClassificationNode, the parent NodePath is used (that of the parent ClassificationNode of the Module).

Parameters:

nodePath - NodePath.

Returns:

GroupId segment.

convertPascalCaseToLowercaseWithDashes

public static String convertPascalCaseToLowercaseWithDashes(String stringPascalCase)

Converts a PascalCase (or camelCase) string to lowercase with dashes.

Parameters:

stringPascalCase - See description.

Returns:

See description.

isDirectoryEmpty

public static boolean isDirectoryEmpty(Path path)

applyDragomSystemProperties

public static void applyDragomSystemProperties()

Applies system properties from the META-INF/dragom.properties classpath resource.

This method can be called from many places where it is expected that Dragom properties be available as system properties. This class ensures that loading the system properties is done only once.

System properties take precedence over Dragom properties.

getJsonAttr

public static Map<String,String> getJsonAttr(String message,
                                             Map<String,String> mapAttr)

Helper method to retrieve attributes from a message.

These attributes are stored in a JSONObject at the beginning of the message. The message must therefore start with "{" and continue to a matching closing "}". For now, embedded JSONObject or "}" are not supported.

If the message does not start with "{", an empty Map is returned (not null).

This is intended to be used for storing arbitrary attributes within commit and other messages in SCM's.

Parameters:

message - Message.

mapAttr - Map that will be filled in and returned. If null, a new Map is created, in which case it should not be modified by the caller (it may be immutable, especially if empty).

Returns:

Map of attributes.

getCommitMessageWithoutAttr

public static String getCommitMessageWithoutAttr(String commitMessage)

Helper method to remove commit attributes from a commit message. These attributes are stored in a JSONObject at the beginning of the commit message. The commit message must therefore start with "{" and continue to a matching closing "}". For now, embedded JSONObject or "}" are not supported. If the commit message does not start with "{", the message itself is returned.

Parameters:

commitMessage - Commit message.

Returns:

Commit message with attributes removed.

isNotNullAndTrue

public static boolean isNotNullAndTrue(Boolean aBoolean)

Facilitates interpreting Boolean objects.

Parameters:

aBoolean - Boolean.

Returns:

true if aBoolean is not null and true (null is assumed to mean false).

isNotNullAndTrue

public static boolean isNotNullAndTrue(String stringBoolean)

Facilitates interpreting Boolean objects.

Parameters:

stringBoolean - null, "true" or "false".

Returns:

true if stringBoolean is not null and "true" (null is assumed to mean false).

getLocalizedMsgPattern

public static String getLocalizedMsgPattern(String msgPatternKey)

Parameters:

msgPatternKey - Message pattern key within the ResourceBundle.

Returns:

Message pattern associated with the key.

getInfoAlwaysNeverAskUserResponse

public static AlwaysNeverAskUserResponse getInfoAlwaysNeverAskUserResponse(org.azyva.dragom.execcontext.plugin.UserInteractionCallbackPlugin userInteractionCallbackPlugin,
                                                                           String prompt,
                                                                           AlwaysNeverAskUserResponse alwaysNeverAskUserResponseDefaultValue)

Facilitates letting the user input a AlwaysNeverAskUserResponse. If info ends with "*" it is replaced with " (Y(es always), N(ever), A(sk again)) [<default>]? " where <default> is "Y", "N" or "A" depending on alwaysNeverAskUserResponseDefaultValue. As a convenience, "1" and "0" can also be entered by the user to mean "Yes always" and "Never" respectively. The user can also enter the string value of the enum constants ("ALWAYS", "NEVER" and "ASK").

Parameters:

userInteractionCallbackPlugin - UserInteractionCallbackPlugin.

prompt - See corresponding parameter in UserInteractionCallbackPlugin.getInfo.

alwaysNeverAskUserResponseDefaultValue - Default user response. It is translated to the defaultValue parameter in UserInteractionCallbackPlugin.getInfo.

Returns:

AlwaysNeverAskUserResponse.

getInfoAlwaysNeverAskUserResponseAndHandleAsk

public static AlwaysNeverAskUserResponse getInfoAlwaysNeverAskUserResponseAndHandleAsk(org.azyva.dragom.execcontext.plugin.RuntimePropertiesPlugin runtimePropertiesPlugin,
                                                                                       String runtimeProperty,
                                                                                       org.azyva.dragom.execcontext.plugin.UserInteractionCallbackPlugin userInteractionCallbackPlugin,
                                                                                       String prompt)

This is an extension to the method getInfoAlwaysNeverAskUserResponse that handles storing the user response in a runtime property.

First it gets the value of the runtime property runtimeProperty. If it is AlwaysNeverAskUserResponse.ASK (or null) it delegates to the getInfoAlwaysNeverAskUserResponse method. If the user does not respond AlwaysNeverAskUserResponse.ASK, the response is written back to the runtime property (ASK is the default value for the property).

This is at the limit of being generic. It is very specific to one way of handling AlwaysNeverAskUserResponse user input together with a runtime property. But this idiom occurs in many places in Dragom and it was deemed worth factoring it out.

Parameters:

runtimePropertiesPlugin - RuntimePropertiesPlugin.

runtimeProperty - Runtime property.

userInteractionCallbackPlugin - See corresponding parameter in getInfoAlwaysNeverAskUserResponse.

prompt - See corresponding parameter in getInfoAlwaysNeverAskUserResponse.

Returns:

AlwaysNeverAskUserResponse.

getInfoAlwaysNeverYesNoAskUserResponse

public static AlwaysNeverYesNoAskUserResponse getInfoAlwaysNeverYesNoAskUserResponse(org.azyva.dragom.execcontext.plugin.UserInteractionCallbackPlugin userInteractionCallbackPlugin,
                                                                                     String prompt,
                                                                                     AlwaysNeverYesNoAskUserResponse alwaysNeverYesNoAskUserResponseDefaultValue)

Facilitates letting the user input a AlwaysNeverYesNoAskUserResponse. If info ends with "*" it is replaced with " (Y(es always), N(ever), YA (Yes, Ask again), NA (No, Ask again)) [<default>]? " where <default> is "Y", "N", "YA" or "NA" depending on alwaysNeverYesNoAskUserResponseDefaultValue. As a convenience, "1" and "0" can also be entered by the user to mean "Yes always" and "Never" respectively. The user can also enter the string value of the enum constants ("ALWAYS", "NEVER", "YES_ASK" and "NO_ASK").

Parameters:

userInteractionCallbackPlugin - UserInteractionCallbackPlugin.

prompt - See corresponding parameter in UserInteractionCallbackPlugin.getInfo.

alwaysNeverYesNoAskUserResponseDefaultValue - Default user response. It is translated to the defaultValue parameter in UserInteractionCallbackPlugin.getInfo.

Returns:

AlwaysNeverYesNoAskUserResponse.

getInfoAlwaysNeverYesNoAskUserResponseAndHandleAsk

public static AlwaysNeverYesNoAskUserResponse getInfoAlwaysNeverYesNoAskUserResponseAndHandleAsk(org.azyva.dragom.execcontext.plugin.RuntimePropertiesPlugin runtimePropertiesPlugin,
                                                                                                 String runtimeProperty,
                                                                                                 org.azyva.dragom.execcontext.plugin.UserInteractionCallbackPlugin userInteractionCallbackPlugin,
                                                                                                 String prompt)

This is an extension to the method getInfoAlwaysNeverYesNoAskUserResponse that handles storing the user response in a runtime property.

First it gets the value of the runtime property runtimeProperty. If it is AlwaysNeverYesNoAskUserResponse.YES_ASK (or null) or AlwaysNeverYesNoAskUserResponse.NO_ASK it delegates to the getInfoAlwaysNeverYesNoAskUserResponse method with YES_ASK and NO_ASK respectively as the default value. The response is written back to the runtime property, unless it is AlwaysNeverYesNoAskUserResponse.YES_ASK and it was null to start with (YES_ASK is the default value for the property).

This is at the limit of being generic. It is very specific to one way of handling AlwaysNeverYesNoAskUserResponse user input together with a runtime property. But this idiom occurs in many places in Dragom and it was deemed worth factoring it out.

Parameters:

runtimePropertiesPlugin - RuntimePropertiesPlugin.

runtimeProperty - Runtime property.

userInteractionCallbackPlugin - See corresponding parameter in getInfoAlwaysNeverYesNoAskUserResponse.

prompt - See corresponding parameter in getInfoAlwaysNeverYesNoAskUserResponse.

Returns:

AlwaysNeverYesNoAskUserResponse.

getInfoYesAlwaysNoUserResponse

public static YesAlwaysNoUserResponse getInfoYesAlwaysNoUserResponse(org.azyva.dragom.execcontext.plugin.UserInteractionCallbackPlugin userInteractionCallbackPlugin,
                                                                     String prompt,
                                                                     YesAlwaysNoUserResponse yesAlwaysNoUserResponseDefaultValue)

Facilitates letting the user input a YesAlwaysNoUserResponse. If info ends with "*" it is replaced with " (Y(es), A(ways), N(o)) [<default>]? " where <default> is "Y", "A" or "N" depending on yesAlwaysNoUserResponseDefaultValue. As a convenience, "1" and "0" can also be entered by the user to mean "Yes" and "No" respectively. The user can also enter the string value of the enum constants ("YES", "YES_ALWAYS" and "NO").

Parameters:

userInteractionCallbackPlugin - UserInteractionCallbackPlugin.

prompt - See corresponding parameter in UserInteractionCallbackPlugin.getInfo.

yesAlwaysNoUserResponseDefaultValue - Default user response. It is translated to the defaultValue parameter in UserInteractionCallbackPlugin.getInfo.

Returns:

YesAlwaysNoUserResponse.

getInfoYesAlwaysNoAbortUserResponse

public static YesAlwaysNoUserResponse getInfoYesAlwaysNoAbortUserResponse(org.azyva.dragom.execcontext.plugin.UserInteractionCallbackPlugin userInteractionCallbackPlugin,
                                                                          String prompt,
                                                                          YesAlwaysNoUserResponse yesAlwaysNoUserResponseDefaultValue)

Facilitates letting the user input a YesAlwaysNoUserResponse with support for "no" and "abort" responses. If info ends with "*" it is replaced with " (Y(es), A(ways), N(o), B(aBort)) [<default>]? " where <default> is "Y", "A", "N" or "B" depending on yesAlwaysNoUserResponseDefaultValue. As a convenience, "1" and "0" can also be entered by the user to mean "Yes" and "No" respectively. The user can also enter the string value of the enum constants ("YES", "YES_ALWAYS", "NO" and "NO_ABORT").

Parameters:

userInteractionCallbackPlugin - UserInteractionCallbackPlugin.

prompt - See corresponding parameter in UserInteractionCallbackPlugin.getInfo.

yesAlwaysNoUserResponseDefaultValue - Default user response. It is translated to the defaultValue parameter in UserInteractionCallbackPlugin.getInfo.

Returns:

YesAlwaysNoUserResponse.

getInfoYesNoUserResponse

public static YesAlwaysNoUserResponse getInfoYesNoUserResponse(org.azyva.dragom.execcontext.plugin.UserInteractionCallbackPlugin userInteractionCallbackPlugin,
                                                               String prompt,
                                                               YesAlwaysNoUserResponse yesAlwaysNoUserResponseDefaultValue)

This method is very similar to getInfoYesAlwaysNoUserResponse except that it does not support the "Always" response. It still returns a YesAlwaysNoUserResponse but YesAlwaysNoUserResponse.YES_ALWAYS will not be returned.

Parameters:

userInteractionCallbackPlugin - UserInteractionCallbackPlugin.

prompt - See corresponding parameter in UserInteractionCallbackPlugin.getInfo.

yesAlwaysNoUserResponseDefaultValue - Default user response. It is translated to the defaultValue parameter in UserInteractionCallbackPlugin.getInfo.

Returns:

YesAlwaysNoUserResponse.

getInfoVersion

public static org.azyva.dragom.model.Version getInfoVersion(org.azyva.dragom.model.VersionType versionType,
                                                            org.azyva.dragom.model.plugin.ScmPlugin scmPlugin,
                                                            org.azyva.dragom.execcontext.plugin.UserInteractionCallbackPlugin userInteractionCallbackPlugin,
                                                            String prompt,
                                                            org.azyva.dragom.model.Version versionDefaultValue)

Facilitates letting the user input a Version. If info ends with "*" it is replaced with text that guides the user in inputting the Version. If scmPlugin is not null that text is " (use the format <format>/<version>; version must exist) [<default>]? " where <format> is "S", "D" or "S/D" depending on whether versionType is VersionType.STATIC, VersionType.DYNAMIC or null, and where <default> is versionDefaultValue. If versionDefaultValue is null, the last part " [<default>]" is not included. If scmPlugin is null that text is similar, but excludes that part saying that the Version must exist. If versionType is not null, the type of Version will be validated to be as such. If scmPlugin is not null, the existence of the Version will be validated.

Parameters:

versionType - VersionType.

scmPlugin - ScmPlugin.

userInteractionCallbackPlugin - UserInteractionCallbackPlugin.

prompt - See corresponding parameter in UserInteractionCallbackPlugin.getInfo.

versionDefaultValue - Default user response. It is translated to the defaultValue parameter in UserInteractionCallbackPlugin.getInfo.

Returns:

Version.

getNodePluginFactory

public static org.azyva.dragom.model.plugin.NodePluginFactory getNodePluginFactory(String stringClassNodePlugin)

Gets an instance of NodePluginFactory for a plugin implementation class.

It is assumed the NodePlugin implementation class implements NodePluginFactory. The caller must have verified if the NodePlugin implementation class uses the constructor pattern and if so, not call this method.

This method factors out the algorithm that verifies if the class has a getInstance static method, if so calls it to obtain the NodePluginFactory and otherwise simply instantiates the class.

This s used by getDefaultClassNodePlugin(java.lang.String) and getDefaultPluginId(java.lang.Class<? extends org.azyva.dragom.model.plugin.NodePlugin>, java.lang.String), as well as SimpleNode.getNodePlugin(java.lang.Class<NodePluginInterface>, java.lang.String).

Parameters:

stringClassNodePlugin - NodePlugin implementation class. Must implement NodePluginFactory.

Returns:

NodePluginFactory.

getDefaultClassNodePlugin

public static Class<? extends org.azyva.dragom.model.plugin.NodePlugin> getDefaultClassNodePlugin(String pluginClass)

Returns the default NodePlugin interface for a plugin implementation class.

This method implements the strategy described in the description of PluginDefConfig.

Parameters:

pluginClass - Name of the plugin implementation class.

Returns:

Default Class of the NodePlugin.

getDefaultPluginId

public static String getDefaultPluginId(Class<? extends org.azyva.dragom.model.plugin.NodePlugin> classNodePlugin,
                                        String pluginClass)

Returns the default plugin ID for NodePlugin interface supported by a plugin implementation class.

This method implements the strategy described in the description of PluginDefConfig.

Parameters:

classNodePlugin - Class of the NodePlugin.

pluginClass - Name of the plugin implementation class.

Returns:

Default plugin ID.

isWindows

public static boolean isWindows()

Returns:

Indicates if we are running on Windows. If not, we can conclude we are running on a *nix.

handleDoYouWantToContinue

public static boolean handleDoYouWantToContinue(String context)

Helper method that handles generically the typical question "Do you want to continue?".

The context of the action having just been performed and for which we ask the user if he wants to continue is taken into consideration. If the IND_NO_CONFIRM runtime property is true, true is returned regardless of the context. Otherwise the context-specific IND_NO_CONFIRM.<context> is used.

If the user responds to always continue, it is understood to be for the specified context.

If the user responds to not continue, false is returned and the IND_ABORT runtime property is set to true. See isAbort().

Parameters:

context - Context.

Returns:

true if continue, false if abort.

handleDoYouWantToContinueWithIndividualNo

public static boolean handleDoYouWantToContinueWithIndividualNo(String context)

Helper method that handles generically the typical question "Do you want to continue?".

Its behavior is similar to that of handleDoYouWantToContinue(java.lang.String) except that it handle the "no" response to mean "no for this iteration" (and simply return false), and provides a separate "abort" response to mean "no and abort" (and return false and set the IND_ABORT runtime property to true).

Parameters:

context - Context.

Returns:

true if continue, false if not.

isAbort

public static boolean isAbort()

Returns:

The value of the IND_ABORT runtime property which can be set by handleDoYouWantToContinue(java.lang.String) or setAbort().

setAbort

public static void setAbort()

Sets the IND_ABORT runtime property explicitly.

isDigits

public static boolean isDigits(String string)

Verifies if a String contains only ASCII digits.

Parameters:

string - String.

Returns:

true if the token contains only ASCII digits.

spaces

public static String spaces(int length)

Returns a string of length spaces.

Internally manages a single StringBuilder from which substring of the requested lengths can be obtained.

A ReadWriteLock is used to protect the non-thread-safe StringBuilder. The code used is inpired from the sample shown in ReentrantReadWriteLock.

Parameters:

length - Number of spaces.

Returns:

String of length spaces.

isPosix

public static boolean isPosix()

Returns:

Indicates if the system is Posix compliant, for file operations at least.