com.evento.parser.model.BundleDescription Maven / Gradle / Ivy
Show all versions of evento-parser Show documentation
package com.evento.parser.model;
import com.evento.parser.model.component.Component;
import com.evento.parser.model.payload.PayloadDescription;
import java.io.Serializable;
import java.util.ArrayList;
/**
* A class representing a bundle description.
*
* A bundle description contains information about a software bundle, including its components, payload descriptions,
* bundle ID, bundle version, autorun status, minimum and maximum instances, description, and detail.
*
* The bundle description can be serialized and deserialized.
*/
public class BundleDescription implements Serializable {
private ArrayList components;
private ArrayList payloadDescriptions;
private String bundleId;
private long bundleVersion;
private boolean autorun;
private int minInstances;
private int maxInstances;
private String description;
private String detail;
private String linePrefix;
private boolean deployable;
/**
* Constructs a new BundleDescription with the specified parameters.
*
* @param bundleId the unique identifier of the bundle
* @param bundleVersion the version number of the bundle
* @param autorun indicates whether the bundle should automatically run
* @param minInstances the minimum number of instances allowed for the bundle
* @param maxInstances the maximum number of instances allowed for the bundle
* @param components the list of components included in the bundle
* @param payloadDescriptions the list of payload descriptions included in the bundle
* @param description a brief description of the bundle
* @param detail detailed information about the bundle
* @param linePrefix a prefix for each line in the bundle
*/
public BundleDescription(String bundleId, long bundleVersion, boolean autorun,
int minInstances,
int maxInstances,
ArrayList components,
ArrayList payloadDescriptions,
String description,
String detail,
String linePrefix,
boolean deployable) {
this.components = components;
this.payloadDescriptions = payloadDescriptions;
this.bundleId = bundleId;
this.bundleVersion = bundleVersion;
this.autorun = autorun;
this.minInstances = minInstances;
this.maxInstances = maxInstances;
this.description = description;
this.detail = detail;
this.linePrefix = linePrefix;
this.deployable = deployable;
}
/**
* The BundleDescription class represents a description of a bundle.
*/
public BundleDescription() {
}
/**
* Retrieves the list of components included in the bundle.
*
* @return the list of components included in the bundle
*/
public ArrayList getComponents() {
return components;
}
/**
* Sets the list of components included in the bundle.
*
* @param components the list of components to be set
*/
public void setComponents(ArrayList components) {
this.components = components;
}
/**
* Retrieves the list of payload descriptions included in the bundle.
*
* @return the list of payload descriptions included in the bundle
*/
public ArrayList getPayloadDescriptions() {
return payloadDescriptions;
}
/**
* Sets the list of payload descriptions included in the bundle.
*
* @param payloadDescriptions the list of payload descriptions to be set
*/
public void setPayloadDescriptions(ArrayList payloadDescriptions) {
this.payloadDescriptions = payloadDescriptions;
}
/**
* Retrieves the bundle ID of the BundleDescription object.
*
* @return the bundle ID
*/
public String getBundleId() {
return bundleId;
}
/**
* Sets the bundle ID of the BundleDescription object.
*
* @param bundleId the bundle ID to be set
*/
public void setBundleId(String bundleId) {
this.bundleId = bundleId;
}
/**
* Retrieves the version of the bundle.
*
* @return the version of the bundle
*/
public long getBundleVersion() {
return bundleVersion;
}
/**
* Sets the version of the bundle.
*
* @param bundleVersion the version of the bundle to be set
*/
public void setBundleVersion(long bundleVersion) {
this.bundleVersion = bundleVersion;
}
/**
* Retrieves the value of the autorun attribute.
*
* @return true if the bundle should autorun, false otherwise
*/
public boolean getAutorun() {
return autorun;
}
/**
* Sets the autorun attribute for the BundleDescription object.
*
* @param autorun whether the bundle should autorun
*/
public void setAutorun(boolean autorun) {
this.autorun = autorun;
}
/**
* Retrieves the minimum number of instances allowed for the bundle.
*
* @return the minimum number of instances allowed for the bundle
*/
public int getMinInstances() {
return minInstances;
}
/**
* Sets the minimum number of instances allowed for the bundle.
*
* @param minInstances the minimum number of instances to be set
*/
public void setMinInstances(int minInstances) {
this.minInstances = minInstances;
}
/**
* Retrieves the maximum number of instances allowed for the bundle.
*
* @return the maximum number of instances allowed for the bundle
*/
public int getMaxInstances() {
return maxInstances;
}
/**
* Sets the maximum number of instances allowed for the bundle.
*
* @param maxInstances the maximum number of instances to be set
*/
public void setMaxInstances(int maxInstances) {
this.maxInstances = maxInstances;
}
/**
* Retrieves the description of the bundle.
*
* @return the description of the bundle
*/
public String getDescription() {
return description;
}
/**
* Sets the description of the BundleDescription.
*
* @param description the new description for the BundleDescription
*/
public void setDescription(String description) {
this.description = description;
}
/**
* Retrieves the detailed information about the bundle.
*
* @return the detailed information about the bundle
*/
public String getDetail() {
return detail;
}
/**
* Sets the detailed information about the bundle.
*
* @param detail the detailed information about the bundle
*/
public void setDetail(String detail) {
this.detail = detail;
}
/**
* Retrieves the prefix for each line in the bundle*/
public String getLinePrefix() {
return linePrefix;
}
/**
* Sets the prefix for each line in the bundle.
*
* @param linePrefix the prefix to be set for each line in the bundle
*/
public void setLinePrefix(String linePrefix) {
this.linePrefix = linePrefix;
}
/**
* Retrieves the deployable status of the bundle.
*
* @return true if the bundle is deployable, false otherwise
*/
public boolean getDeployable() {
return deployable;
}
/**
* Sets the deployable status of the bundle.
*
* @param deployable whether the bundle is deployable
*/
public void setDeployable(boolean deployable) {
this.deployable = deployable;
}
}