org.saynotobugs.confidence.Assessment Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2024 dmfs GmbH
 *
 * 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.saynotobugs.confidence;

import org.dmfs.srcless.annotations.composable.Composable;


/**
 * The assessment of an object in regard to a specific {@link Quality}.
 * 
 * Note, {@link Assessment}s must be immutable. If a {@link Quality} returns an {@link Assessment} of a mutable object
 * the {@link Assessment} instance MUST return the same result when the object is mutated.
 */
@Composable(packageName = "org.saynotobugs.confidence.assessment")
public interface Assessment
{
    boolean isSuccess();

    /**
     * Provides a {@link Description} of this {@link Assessment}. In case of a failure this describes the
     * {@link Quality}s that didn't pass the assessemnt. In case of success, the result describes the {@link Quality}s
     * that passed. Often that's the simple past version of the description of the {@link Quality} itself.
     */
    Description description();
}