sdks/java/core/src/main/java/org/apache/beam/sdk/testing/SuccessOrFailure.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.beam.sdk.testing;

import com.google.common.base.MoreObjects;
import java.io.Serializable;
import javax.annotation.Nullable;
import org.apache.beam.sdk.coders.DefaultCoder;
import org.apache.beam.sdk.coders.SerializableCoder;

/**
 * Output of {@link PAssert}. Passed to a conclude function to act upon.
 */
@DefaultCoder(SerializableCoder.class)
public final class SuccessOrFailure implements Serializable {
  // TODO Add a SerializableThrowable. instead of relying on PAssertionSite.(BEAM-1898)

  private final boolean isSuccess;
  @Nullable
  private final PAssert.PAssertionSite site;
  @Nullable
  private final String message;

  private SuccessOrFailure() {
    this(true, null, null);
  }

  private SuccessOrFailure(
      boolean isSuccess,
      @Nullable PAssert.PAssertionSite site,
      @Nullable String message) {
    this.isSuccess = isSuccess;
    this.site = site;
    this.message = message;
  }

  public boolean isSuccess() {
    return isSuccess;
  }

  @Nullable
  public AssertionError assertionError() {
    return  site == null ? null : site.wrap(message);
  }

  public static SuccessOrFailure success() {
    return new SuccessOrFailure(true, null, null);
  }

  public static SuccessOrFailure failure(@Nullable PAssert.PAssertionSite site,
      @Nullable String message) {
    return new SuccessOrFailure(false, site, message);
  }

  public static SuccessOrFailure failure(@Nullable PAssert.PAssertionSite site) {
    return new SuccessOrFailure(false, site, null);
  }

  @Override
  public String toString() {
    return MoreObjects.toStringHelper(this)
        .add("isSuccess", isSuccess())
        .addValue(message)
        .omitNullValues()
        .toString();
  }
}