net.scattersphere.client.handler.AbstractCommandHandler Maven / Gradle / Ivy

Go to download
/*
 * Scattersphere
 * Copyright 2014-2015, Scattersphere Project.
 *
 * 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 net.scattersphere.client.handler;

import net.scattersphere.api.Client;
import net.scattersphere.api.ClientConnection;
import net.scattersphere.api.StreamClient;

import java.io.PrintWriter;
import java.util.Objects;

/**
 * This is a default implementation of the command handler, which provides a way to supply the {@link PrintWriter} and
 * {@link ClientConnection} links.
 *
 * Created by kenji on 12/1/14.
 */
public abstract class AbstractCommandHandler implements CommandHandler {

    private final PrintWriter out;
    private final Client client;

    /**
     * Constructor.
     *
     * @param out The currently active {@link PrintWriter} object.
     * @param client Currently active {@link net.scattersphere.api.Client}.
     */
    protected AbstractCommandHandler(PrintWriter out, Client client) {
        Objects.requireNonNull(out);
        Objects.requireNonNull(client);

        this.out = out;
        this.client = client;
    }

    /**
     * Retrieves the {@link PrintWriter} object.
     *
     * @return {@link PrintWriter} object.
     */
    protected PrintWriter getPrintWriter() {
        return out;
    }

    /**
     * Retrieves the {@link net.scattersphere.api.Client} object.
     *
     * @return {@link net.scattersphere.api.Client} object.
     */
    protected Client getClient() {
        return client;
    }

}