Deployment (WildFly Plugin Core Utilities 1.1.0.Alpha9 API)

java.lang.Object
- org.wildfly.plugin.core.Deployment

All Implemented Interfaces:

Comparable<DeploymentDescription>, DeploymentDescription
```
public class Deployment
extends Object
implements DeploymentDescription
```
Represents a deployment to be deployed or redeployed to a server.
Instances of this are not thread-safe.

Author:

James R. Perkins

Constructor Summary

Constructors
Constructor and Description
`Deployment(File content)` Creates a new deployment for the file.
`Deployment(InputStream content, String name)` Creates a new deployment for the input stream.
`Deployment(Path content)` Creates a new deployment for the path.

Method Summary

Methods
Modifier and Type	Method and Description
`Deployment`	`addServerGroup(String serverGroup)` Adds a server group for the deployment.
`Deployment`	`addServerGroups(Collection<String> serverGroups)` Adds the server groups for the deployment.
`Deployment`	`addServerGroups(String... serverGroups)` Adds the server groups for the deployment.
`int`	`compareTo(DeploymentDescription o)`
`boolean`	`equals(Object obj)`
`String`	`getName()` Returns the name for this deployment.
`String`	`getRuntimeName()` Returns the runtime name set for the deployment which may be `null`.
`Set<String>`	`getServerGroups()` Returns the server groups for this deployment.
`int`	`hashCode()`
`static Deployment`	`of(File content)` Creates a new deployment for the file.
`static Deployment`	`of(InputStream content, String name)` Creates a new deployment for the input stream.
`static Deployment`	`of(Path content)` Creates a new deployment for the path.
`Deployment`	`setName(String name)` Sets the name for the deployment.
`Deployment`	`setRuntimeName(String runtimeName)` Sets the runtime name for the deployment.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Deployment
```
public Deployment(File content)
```
    Creates a new deployment for the file. If the file is a directory the content will be deployed exploded using the file system location.
    
    Parameters:
    content - the file containing the content
  - Deployment
```
public Deployment(Path content)
```
    Creates a new deployment for the path. If the path is a directory the content will be deployed exploded using the file system location.
    
    Parameters:
    content - the path containing the content
  - Deployment
```
public Deployment(InputStream content,
          String name)
```
    Creates a new deployment for the input stream. The name is required for the deployment and cannot be null. If setName(String) with a null argument is invoked when using this constructor an IllegalArgumentException will be thrown.
    The content will be copied, stored in-memory and then closed. Large content should be written to a file and the Deployment(Path) or Deployment(File) constructor should be used.
    
    Parameters:
    content - the input stream representing the content
    name - the name for the deployment
- Method Detail
  - of
```
public static Deployment of(File content)
```
    Creates a new deployment for the file. If the file is a directory the content will be deployed exploded using the file system location.
    
    Parameters:
    content - the file containing the content
    
    Returns:
    the deployment
  - of
```
public static Deployment of(Path content)
```
    Creates a new deployment for the path. If the path is a directory the content will be deployed exploded using the file system location.
    
    Parameters:
    content - the path containing the content
    
    Returns:
    the deployment
  - of
```
public static Deployment of(InputStream content,
            String name)
```
    Creates a new deployment for the input stream. The name is required for the deployment and cannot be null. If setName(String) with a null argument is invoked when using this static factory an IllegalArgumentException will be thrown.
    The content will be copied, stored in-memory and then closed. Large content should be written to a file and the of(Path) or of(File) static factory methods should be used.
    
    Parameters:
    content - the input stream representing the content
    name - the name for the deployment
    
    Returns:
    the deployment
  - addServerGroup
```
public Deployment addServerGroup(String serverGroup)
```
    Adds a server group for the deployment.
    
    Parameters:
    serverGroup - the server group to add
    
    Returns:
    this deployment
  - addServerGroups
```
public Deployment addServerGroups(String... serverGroups)
```
    Adds the server groups for the deployment.
    
    Parameters:
    serverGroups - the server groups to add
    
    Returns:
    this deployment
  - addServerGroups
```
public Deployment addServerGroups(Collection<String> serverGroups)
```
    Adds the server groups for the deployment.
    
    Parameters:
    serverGroups - the server groups to add
    
    Returns:
    this deployment
  - getServerGroups
```
public Set<String> getServerGroups()
```
    Description copied from interface: DeploymentDescription
    
    Returns the server groups for this deployment.
    
    Specified by:
    
    getServerGroups in interface DeploymentDescription
    
    Returns:
    a set of server groups for this deployment
  - getName
```
public String getName()
```
    Description copied from interface: DeploymentDescription
    
    Returns the name for this deployment.
    
    Specified by:
    
    getName in interface DeploymentDescription
    
    Returns:
    the name for this deployment
  - setName
```
public Deployment setName(String name)
```
    Sets the name for the deployment. This can be null for a deployment created based on a file system path. If the deployment was created using in input stream and the value is null an IllegalArgumentException will be thrown.
    
    Parameters:
    name - the name for the deployment
    
    Returns:
    this deployment
  - getRuntimeName
```
public String getRuntimeName()
```
    Returns the runtime name set for the deployment which may be null.
    
    Returns:
    the runtime name set or null if one was not set
  - setRuntimeName
```
public Deployment setRuntimeName(String runtimeName)
```
    Sets the runtime name for the deployment.
    
    Parameters:
    runtimeName - the runtime name, can be null
    
    Returns:
    this deployment
  - compareTo
```
public int compareTo(DeploymentDescription o)
```
    Specified by:
    
    compareTo in interface Comparable<DeploymentDescription>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Deployment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Deployment

Deployment

Deployment

Method Detail

of

of

of

addServerGroup

addServerGroups

addServerGroups

getServerGroups

getName

setName

getRuntimeName

setRuntimeName

compareTo

hashCode

equals

toString