/*
 * MIT License
 *
 * Copyright (c) 2017 Connor Hartley
 *
 * 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 io.github.connorhartley.guardian.sequence.condition;

import io.github.connorhartley.guardian.sequence.SequenceReport;

public class ConditionResult {

    private final boolean pass;
    private final SequenceReport sequenceReport;
    
    public ConditionResult(Boolean pass, SequenceReport sequenceReport) {
        this.pass = pass;
        this.sequenceReport = sequenceReport;
    }

    public boolean hasPassed() {
        return this.pass;
    }

    public SequenceReport getSequenceReport() {
        return this.sequenceReport;
    }

}

/*
 * MIT License
 *
 * Copyright (c) 2017 Connor Hartley
 *
 * 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 io.github.connorhartley.guardian.sequence.condition;

import io.github.connorhartley.guardian.sequence.SequenceReport;

/**
 * Condition Result
 *
 * Represents the result of a sequence and decides
 * if it should cancel or not.
 */
public class ConditionResult {

    private final boolean pass;
    private final SequenceReport sequenceReport;
    
    public ConditionResult(Boolean pass, SequenceReport sequenceReport) {
        this.pass = pass;
        this.sequenceReport = sequenceReport;
    }

    /**
     * Has Passed
     *
     * <p>Returns true if the condition result is set to pass.</p>
     *
     * @return True if the condition passes
     */
    public boolean hasPassed() {
        return this.pass;
    }

    /**
     * Get Sequence Report
     *
     * <p>Returns the sequence report.</p>
     *
     * @return The sequence report
     */
    public SequenceReport getSequenceReport() {
        return this.sequenceReport;
    }

}

Add javadocs to condition result