<commit_before>/*
 * Copyright 2014-2017 Real Logic Ltd.
 *
 * 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 org.agrona.concurrent;

/**
 * An Agent is scheduled to do work on a thread on a duty cycle. Each Agent should have a defined role in a system.
 *
 * {@link #onStart()}, {@link #doWork()}, and {@link #onClose()} will all be called by the same thread and in
 * threadsafe manner.
 */
public interface Agent
{
    /**
     * To be overridden by Agents that need to do resource init on start.
     * <p>
     * This method will be called by the agent thread. It will only be called once.
     * <p>
     * <b>Note:</b> Implementations of this method must be idempotent.
     */
    default void onStart()
    {
        // default to do nothing unless you want to handle the notification.
    }

    /**
     * An agent should implement this method to do its work.
     * <p>
     * The return value is used for implementing a backoff strategy that can be employed when no work is
     * currently available for the agent to process.
     * <p>
     * If the Agent should terminate and close then a {@link AgentTerminationException} can be thrown.
     *
     * @return 0 to indicate no work was currently available, a positive value otherwise.
     * @throws java.lang.Exception if an error has occurred
     */
    int doWork() throws Exception;

    /**
     * To be overridden by Agents that need to do resource cleanup on close.
     * <p>
     * This method will be called after the agent thread has terminated. It will only be called once by a single thread.
     * <p>
     * <b>Note:</b> Implementations of this method must be idempotent.
     */
    default void onClose()
    {
        // default to do nothing unless you want to handle the notification.
    }

    /**
     * Get the name of this agent's role.
     *
     * @return the name of this agent's role.
     */
    String roleName();
}
<commit_msg>[Java] Javadoc.<commit_after>/*
 * Copyright 2014-2017 Real Logic Ltd.
 *
 * 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 org.agrona.concurrent;

/**
 * An Agent is scheduled to do work on a thread on a duty cycle. Each Agent should have a defined role in a system.
 *
 * {@link #onStart()}, {@link #doWork()}, and {@link #onClose()} will all be called by the same thread and in a
 * threadsafe manner.
 */
public interface Agent
{
    /**
     * To be overridden by Agents that need to do resource init on start.
     * <p>
     * This method will be called by the agent thread. It will only be called once.
     * <p>
     * <b>Note:</b> Implementations of this method must be idempotent.
     */
    default void onStart()
    {
        // default to do nothing unless you want to handle the notification.
    }

    /**
     * An agent should implement this method to do its work.
     * <p>
     * The return value is used for implementing a backoff strategy that can be employed when no work is
     * currently available for the agent to process.
     * <p>
     * If the Agent should terminate and close then a {@link AgentTerminationException} can be thrown.
     *
     * @return 0 to indicate no work was currently available, a positive value otherwise.
     * @throws java.lang.Exception if an error has occurred
     */
    int doWork() throws Exception;

    /**
     * To be overridden by Agents that need to do resource cleanup on close.
     * <p>
     * This method will be called after the agent thread has terminated. It will only be called once by a single thread.
     * <p>
     * <b>Note:</b> Implementations of this method must be idempotent.
     */
    default void onClose()
    {
        // default to do nothing unless you want to handle the notification.
    }

    /**
     * Get the name of this agent's role.
     *
     * @return the name of this agent's role.
     */
    String roleName();
}

{'fraction_non_alphanumeric': 0.08005733005733005, 'fraction_numerical': 0.005323505323505323, 'mean_word_length': 2.672932330827068, 'pattern_counts': {'":': 0, '<': 23, '<?xml version=': 0, '>': 23, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5446448', 'n_tokens_mistral': 1322, 'n_tokens_neox': 1279, 'n_words': 668}