com.anaptecs.jeaf.services.scheduling.ExecutionStrategy Maven / Gradle / Ivy
/*
* anaptecs GmbH, Ricarda-Huch-Str. 71, 72760 Reutlingen, Germany
*
* Copyright 2004 - 2019. All rights reserved.
*/
package com.anaptecs.jeaf.services.scheduling;
import com.anaptecs.jeaf.core.api.AbstractObjectID;
import com.anaptecs.jeaf.core.api.Identifiable;
import com.anaptecs.jeaf.core.api.MessageConstants;
import com.anaptecs.jeaf.core.api.ServiceObject;
import com.anaptecs.jeaf.core.api.ServiceObjectID;
import com.anaptecs.jeaf.tools.api.Tools;
import com.anaptecs.jeaf.xfun.api.XFun;
import com.anaptecs.jeaf.xfun.api.checks.Check;
/**
* Class is the base class for all execution strategies that are supported by the Scheduling Service. An execution
* strategy defines the algorithm that will be used to determine the exection times of a task.
*
* @author JEAF Generator
* @version JEAF Release 1.4.x
*/
public class ExecutionStrategy implements ServiceObject, Identifiable {
/**
* Default serial version uid.
*/
private static final long serialVersionUID = 1L;
/**
* Reference to the identifier of this object. The reference may be null since an id is not mandatory.
*/
private final ServiceObjectID objectID;
/**
* Initialize object using the passed builder.
*
* @param pBuilder Builder that should be used to initialize this object. The parameter must not be null.
*/
protected ExecutionStrategy( Builder pBuilder ) {
// Ensure that builder is not null.
Check.checkInvalidParameterNull(pBuilder, "pBuilder");
// Read object ID.
AbstractObjectID lObjectID = pBuilder.objectID;
if (lObjectID != null) {
objectID = new ServiceObjectID(pBuilder.objectID);
}
else {
objectID = null;
}
}
/**
* Class implements builder to create a new instance of class ExecutionStrategy. As the class has readonly attributes
* or associations instances can not be created directly. Instead this builder class has to be used.
*/
public static class Builder {
/**
* Reference to the identifier of this object. The reference may be null since an id is not mandatory.
*/
private AbstractObjectID objectID;
/**
* Use {@link #newBuilder()} instead of private constructor to create new builder.
*/
protected Builder( ) {
}
/**
* Use {@link #newBuilder(ExecutionStrategy)} instead of private constructor to create new builder.
*/
protected Builder( ExecutionStrategy pObject ) {
if (pObject != null) {
// Read attribute values from passed object.
objectID = pObject.objectID;
}
}
/**
* Method returns a new builder.
*
* @return {@link Builder} New builder that can be used to create new ImmutablePOJOParent objects.
*/
public static Builder newBuilder( ) {
return new Builder();
}
/**
* Method creates a new builder and initialize it with the data from the passed object.
*
* @param pObject Object that should be used to initialize the builder. The parameter may be null.
* @return {@link Builder} New builder that can be used to create new ExecutionStrategy objects. The method never
* returns null.
*/
public static Builder newBuilder( ExecutionStrategy pObject ) {
return new Builder(pObject);
}
/**
* Method sets the identifier for the object created using the builder. The reference may be null since an id is not
* mandatory.
*/
public Builder setID( AbstractObjectID pObjectID ) {
objectID = pObjectID;
return this;
}
/**
* Method creates a new instance of class ExecutionStrategy. The object will be initialized with the values of the
* builder.
*
* @return ExecutionStrategy Created object. The method never returns null.
*/
public ExecutionStrategy build( ) {
return new ExecutionStrategy(this);
}
/**
* Method creates a new instance of class ExecutionStrategy. The object will be initialized with the values of the
* builder.
*
* @param pValidate Parameter defines if the created POJO should be validated using Java Validation.
* @return ExecutionStrategy Created object. The method never returns null.
*/
public ExecutionStrategy build( boolean pValidate ) {
ExecutionStrategy lPOJO = this.build();
if (pValidate == true) {
Tools.getValidationTools().validateObject(lPOJO);
}
return lPOJO;
}
}
/**
* Method returns the id of this object.
*
* @return {@link ServiceObjectID} ID of this object. Since an object must not have an id the method may also return
* null.
*/
@Override
public final ServiceObjectID getID( ) {
return objectID;
}
/**
* Method returns the unversioned object id of this object.
*
* @return {@link ServiceObjectID} ID of this object. Since an object must not have an id the method may also return
* null.
*/
@Override
public final ServiceObjectID getUnversionedID( ) {
ServiceObjectID lUnversionedID;
if (objectID != null) {
lUnversionedID = objectID.getUnversionedObjectID();
}
else {
lUnversionedID = null;
}
return lUnversionedID;
}
/**
* Method returns a StringBuilder that can be used to create a String representation of this object. the returned
* StringBuilder also takes care about attributes of super classes.
*
* @return {@link StringBuilder} StringBuilder representing this object. The method never returns null.
*/
protected StringBuilder toStringBuilder( ) {
StringBuilder lBuilder = new StringBuilder(256);
lBuilder.append(XFun.getMessageRepository().getMessage(MessageConstants.OBJECT_INFO, this.getClass().getName()));
lBuilder.append('\n');
lBuilder.append(XFun.getMessageRepository().getMessage(MessageConstants.OBJECT_ATTRIBUTES_SECTION));
lBuilder.append('\n');
return lBuilder;
}
/**
* Method creates a new String with the values of all attributes of this class. All references to other objects will
* be ignored.
*
* @return {@link String} String representation of this object. The method never returns null.
*/
@Override
public String toString( ) {
return this.toStringBuilder().toString();
}
}