public class UndeployDescription extends Object implements DeploymentDescription, Comparable<UndeployDescription>
Instances of this are not thread-safe.
Modifier and Type | Method and Description |
---|---|
UndeployDescription |
addServerGroup(String serverGroup)
Adds a server group for the deployment description.
|
UndeployDescription |
addServerGroups(Collection<String> serverGroups)
Adds the server groups for the deployment description.
|
UndeployDescription |
addServerGroups(String... serverGroups)
Adds the server groups for the deployment description.
|
int |
compareTo(UndeployDescription o) |
boolean |
equals(Object obj) |
String |
getName()
Returns the name for this deployment.
|
Set<String> |
getServerGroups()
Returns the server groups for this deployment.
|
int |
hashCode() |
boolean |
isFailOnMissing()
Indicates whether or not a failure should occur if the deployment does not exist on the container.
|
boolean |
isRemoveContent()
Indicates whether or not the content should be removed from the content repository.
|
static UndeployDescription |
of(DeploymentDescription deploymentDescription)
Creates a new undeploy description.
|
static UndeployDescription |
of(String name)
Creates a new undeploy description.
|
UndeployDescription |
setFailOnMissing(boolean failOnMissing)
Sets whether or not a failure should occur if the deployment does exist on the container.
|
UndeployDescription |
setRemoveContent(boolean removeContent)
Sets whether or not the content should be removed after the
undeploy operation. |
String |
toString() |
public static UndeployDescription of(String name)
name
- the name of the deploymentpublic static UndeployDescription of(DeploymentDescription deploymentDescription)
deploymentDescription
- the deployment description to copypublic UndeployDescription addServerGroup(String serverGroup)
serverGroup
- the server group to addpublic UndeployDescription addServerGroups(String... serverGroups)
serverGroups
- the server groups to addpublic UndeployDescription addServerGroups(Collection<String> serverGroups)
serverGroups
- the server groups to addpublic Set<String> getServerGroups()
DeploymentDescription
getServerGroups
in interface DeploymentDescription
public String getName()
DeploymentDescription
getName
in interface DeploymentDescription
public boolean isFailOnMissing()
true
indicates the deployment should fail.true
if the undeploy should fail if not found on the container, otherwise false
public UndeployDescription setFailOnMissing(boolean failOnMissing)
failOnMissing
- true
if the undeploy should fail if the deployment was not found on the server,
false
if the deployment does not exist and the undeploy should be ignoredpublic boolean isRemoveContent()
true
if the content should also be removed from the repository, false
it only an
undeploy
operation should be executed and the content should remain in the repositorypublic UndeployDescription setRemoveContent(boolean removeContent)
undeploy
operation.
The default value is true
.
removeContent
- true
if the content should be removed, false
if the content should remain
in the repositorypublic int compareTo(UndeployDescription o)
compareTo
in interface Comparable<UndeployDescription>
Copyright © 2021 JBoss by Red Hat. All rights reserved.