com.goodow.realtime.Error Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of realtime-api Show documentation
The newest version!
/*
 * Copyright 2012 Goodow.com
 * 
 * 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 com.goodow.realtime;

import com.goodow.realtime.model.util.ModelFactory;

import org.timepedia.exporter.client.Export;
import org.timepedia.exporter.client.ExportPackage;
import org.timepedia.exporter.client.Exportable;

/**
 * An error affecting the realtime document.
 */
@ExportPackage(ModelFactory.PACKAGE_PREFIX_REALTIME)
@Export
public class Error implements Exportable {
  /**
   * Whether the error is fatal. Fatal errors cannot be recovered from and require the document to
   * be reloaded.
   */
  public final boolean isFatal;
  /**
   * A message describing the error.
   */
  public final String message;
  /**
   * The type of the error that occurred.
   */
  public final ErrorType type;

  /**
   * @param type The type of the error that occurred.
   * @param message A message describing the error.
   * @param isFatal Whether the error is fatal.
   */
  public Error(ErrorType type, String message, boolean isFatal) {
    this.type = type;
    this.message = message;
    this.isFatal = isFatal;
  }

  public String getMessage() {
    return message;
  }

  public ErrorType getType() {
    return type;
  }

  public boolean isFatal() {
    return isFatal;
  }
}