com.swirlds.common.threading.framework.config.StoppableThreadConfiguration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of swirlds-common Show documentation
Show all versions of swirlds-common Show documentation
Swirlds is a software platform designed to build fully-distributed applications that harness the power of the cloud without servers. Now you can develop applications with fairness in decision making, speed, trust and reliability, at a fraction of the cost of traditional server-based platforms.
/*
* Copyright (C) 2016-2024 Hedera Hashgraph, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.swirlds.common.threading.framework.config;
import com.swirlds.common.threading.framework.StoppableThread;
import com.swirlds.common.threading.framework.TypedStoppableThread;
import com.swirlds.common.threading.framework.internal.AbstractStoppableThreadConfiguration;
import com.swirlds.common.threading.interrupt.InterruptableRunnable;
import com.swirlds.common.threading.manager.ThreadManager;
/**
* An object responsible for configuring and constructing {@link StoppableThread}s.
*
* @param
* the type of instance that will do work
*/
public class StoppableThreadConfiguration
extends AbstractStoppableThreadConfiguration, T> {
/**
* Build a new stoppable thread configuration with default values.
*
* @param threadManager
* responsible for creating threads
*/
public StoppableThreadConfiguration(final ThreadManager threadManager) {
super(threadManager);
}
/**
* Copy constructor.
*
* @param that
* the configuration to copy.
*/
private StoppableThreadConfiguration(final StoppableThreadConfiguration that) {
super(that);
}
/**
* Get a copy of this configuration. New copy is always mutable,
* and the mutability status of the original is unchanged.
*
* @return a copy of this configuration
*/
public StoppableThreadConfiguration copy() {
return new StoppableThreadConfiguration<>(this);
}
/**
*
* Build a new thread. Do not start it automatically.
*
*
*
* After calling this method, this configuration object should not be modified or used to construct other
* threads.
*
*
* @return a stoppable thread built using this configuration
*/
public TypedStoppableThread build() {
return build(false);
}
/**
*
* Build a new thread.
*
*
*
* After calling this method, this configuration object should not be modified or used to construct other
* threads.
*
*
* @param start
* if true then start the thread before returning it
* @return a stoppable thread built using this configuration
*/
public TypedStoppableThread build(final boolean start) {
final TypedStoppableThread thread = buildStoppableThread(start);
becomeImmutable();
return thread;
}
/**
* {@inheritDoc}
*/
@Override
public T getWork() {
return super.getWork();
}
/**
* {@inheritDoc}
*/
@Override
public StoppableThreadConfiguration setWork(final T work) {
return super.setWork(work);
}
/**
* {@inheritDoc}
*/
@Override
public InterruptableRunnable getFinalCycleWork() {
return super.getFinalCycleWork();
}
/**
* {@inheritDoc}
*/
@Override
public StoppableThreadConfiguration setFinalCycleWork(final InterruptableRunnable finalCycleWork) {
return super.setFinalCycleWork(finalCycleWork);
}
}