ModelObject.java

/*
 * The MIT License
 *
 * Copyright (c) 2015 Red Hat, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.github.olivergondza.dumpling.model;

import javax.annotation.Nonnull;
import java.io.ByteArrayOutputStream;
import java.io.PrintStream;

/**
 * Dumpling model object.
 *
 * @author ogondza
 */
public abstract class ModelObject {

    /**
     * Print object into stream.
     */
    public abstract void toString(@Nonnull PrintStream stream, @Nonnull Mode mode);

    /**
     * Print model object to string in specified mode.
     */
    public String toString(@Nonnull Mode mode) {
        ByteArrayOutputStream baos = new ByteArrayOutputStream();
        toString(new PrintStream(baos), mode);
        return baos.toString();
    }

    /**
     * Default toString implementation for ModelObject.
     */
    @Override
    public String toString() {
        return toString(Mode.HUMAN);
    }

    /**
     * Print output specific for given mode.
     *
     * @author ogondza
     */
    public enum Mode {
        /**
         * Well-defined output format to be consumed by other programs.
         */
        MACHINE,
        /**
         * Pretty printed output easy to read for human.
         */
        HUMAN;

        public boolean isMachine() {
            return this == MACHINE;
        }

        public boolean isHuman() {
            return this == HUMAN;
        }
    }
}