VerificationResult.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.bcel.verifier;

/**
 * A VerificationResult is what a PassVerifier returns after verifying.
 */
public class VerificationResult {

    /**
     * Constant to indicate verification has not been tried yet. This happens if some earlier verification pass did not
     * return VERIFIED_OK.
     */
    public static final int VERIFIED_NOTYET = 0;

    /** Constant to indicate verification was passed. */
    public static final int VERIFIED_OK = 1;

    /** Constant to indicate verfication failed. */
    public static final int VERIFIED_REJECTED = 2;

    /**
     * This string is the canonical message for verifications that have not been tried yet. This happens if some earlier
     * verification pass did not return {@link #VERIFIED_OK}.
     */
    private static final String VERIFIED_NOTYET_MSG = "Not yet verified.";

    /** This string is the canonical message for passed verification passes. */
    private static final String VERIFIED_OK_MSG = "Passed verification.";

    /**
     * Canonical VerificationResult for not-yet-tried verifications. This happens if some earlier verification pass did not
     * return {@link #VERIFIED_OK}.
     */
    public static final VerificationResult VR_NOTYET = new VerificationResult(VERIFIED_NOTYET, VERIFIED_NOTYET_MSG);

    /** Canonical VerificationResult for passed verifications. */
    public static final VerificationResult VR_OK = new VerificationResult(VERIFIED_OK, VERIFIED_OK_MSG);

    /** The numeric status. */
    private final int numeric;

    /** The detailed message. */
    private final String detailMessage;

    /** The usual constructor. */
    public VerificationResult(final int status, final String message) {
        numeric = status;
        detailMessage = message;
    }

    /**
     * Returns if two VerificationResult instances are equal.
     */
    @Override
    public boolean equals(final Object o) {
        if (!(o instanceof VerificationResult)) {
            return false;
        }
        final VerificationResult other = (VerificationResult) o;
        return other.numeric == this.numeric && other.detailMessage.equals(this.detailMessage);
    }

    /** Returns a detailed message. */
    public String getMessage() {
        return detailMessage;
    }

    /**
     * Returns one of the {@link #VERIFIED_OK}, {@link #VERIFIED_NOTYET}, {@link #VERIFIED_REJECTED} constants.
     */
    public int getStatus() {
        return numeric;
    }

    /**
     * @return a hash code value for the object.
     */
    @Override
    public int hashCode() {
        return numeric ^ detailMessage.hashCode();
    }

    /**
     * Returns a String representation of the VerificationResult.
     */
    @Override
    public String toString() {
        String ret = "";
        if (numeric == VERIFIED_NOTYET) {
            ret = "VERIFIED_NOTYET";
        }
        if (numeric == VERIFIED_OK) {
            ret = "VERIFIED_OK";
        }
        if (numeric == VERIFIED_REJECTED) {
            ret = "VERIFIED_REJECTED";
        }
        ret += "\n" + detailMessage + "\n";
        return ret;
    }
}