Repository: incubator-brooklyn Updated Branches: refs/heads/master 78072b294 -> 3d73c9324
Improve documentation for STOP effector parameters Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/e583aa37 Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/e583aa37 Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/e583aa37 Branch: refs/heads/master Commit: e583aa371f86ce2eb72a3cfcb8f260b161437dd7 Parents: de5b8d5 Author: Svetoslav Neykov <[email protected]> Authored: Fri Feb 27 13:19:48 2015 +0200 Committer: Svetoslav Neykov <[email protected]> Committed: Thu Mar 19 16:01:28 2015 +0200 ---------------------------------------------------------------------- .../brooklyn/entity/basic/SoftwareProcess.java | 28 ++++++++++++-------- 1 file changed, 17 insertions(+), 11 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/e583aa37/software/base/src/main/java/brooklyn/entity/basic/SoftwareProcess.java ---------------------------------------------------------------------- diff --git a/software/base/src/main/java/brooklyn/entity/basic/SoftwareProcess.java b/software/base/src/main/java/brooklyn/entity/basic/SoftwareProcess.java index 9219e69..3958e67 100644 --- a/software/base/src/main/java/brooklyn/entity/basic/SoftwareProcess.java +++ b/software/base/src/main/java/brooklyn/entity/basic/SoftwareProcess.java @@ -260,27 +260,33 @@ public interface SoftwareProcess extends Entity, Startable { @Beta public static class StopSoftwareParameters { - /** @since 0.7.0 semantics of parameters to restart being explored - * @deprecated since 0.7.0 use {@link #STOP_MACHINE_MODE} instead */ - @Beta - @Deprecated - public static final ConfigKey<Boolean> STOP_MACHINE = ConfigKeys.newBooleanConfigKey("stopMachine", - "Whether to stop the machine provisioned for this entity: 'true', or 'false' are supported, " - + "with the default being 'true'", true); - //IF_NOT_STOPPED includes STARTING, STOPPING, RUNNING public enum StopMode { ALWAYS, IF_NOT_STOPPED, NEVER }; @Beta /** @since 0.7.0 semantics of parameters to restart being explored */ public static final ConfigKey<StopMode> STOP_PROCESS_MODE = ConfigKeys.newConfigKey(StopMode.class, "stopProcessMode", - "When to stop the process with regard to the entity state", StopMode.IF_NOT_STOPPED); + "When to stop the process with regard to the entity state" + + "ALWAYS will try to stop the process even if the entity is marked as stopped, " + + "IF_NOT_STOPPED stops the process only if the entity is not marked as stopped, " + + "NEVER doesn't stop the process.", StopMode.IF_NOT_STOPPED); @Beta /** @since 0.7.0 semantics of parameters to restart being explored */ public static final ConfigKey<StopMode> STOP_MACHINE_MODE = ConfigKeys.newConfigKey(StopMode.class, "stopMachineMode", "When to stop the machine with regard to the entity state. " + - "ALWAYS will try to stop the machine even if the entity is already stopped, " + - "IF_NOT_STOPPED stops the machine only if the entity is not already stopped, " + + "ALWAYS will try to stop the machine even if the entity is marked as stopped, " + + "IF_NOT_STOPPED stops the machine only if the entity is not marked as stopped, " + "NEVER doesn't stop the machine.", StopMode.IF_NOT_STOPPED); + + /** @since 0.7.0 semantics of parameters to restart being explored + * @deprecated since 0.7.0 use {@link #STOP_MACHINE_MODE} instead */ + @Beta + @Deprecated + public static final ConfigKey<Boolean> STOP_MACHINE = ConfigKeys.newBooleanConfigKey("stopMachine", + "Whether to stop the machine provisioned for this entity: 'true', or 'false' are supported, " + + "with the default being 'true'." + + " 'true' is equivalent to " + STOP_MACHINE_MODE.getName() + " = " + StopMode.IF_NOT_STOPPED.name() + "." + + " 'false' is equivalent to " + STOP_MACHINE_MODE.getName() + " = " + StopMode.NEVER.name() + ".", true); + } // NB: the START, STOP, and RESTART effectors themselves are (re)defined by MachineLifecycleEffectorTasks
