All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.jlab.jaws.entity.ShelvedOverride Maven / Gradle / Ivy

/**
 * Autogenerated by Avro
 *
 * DO NOT EDIT DIRECTLY
 */
package org.jlab.jaws.entity;

import org.apache.avro.generic.GenericArray;
import org.apache.avro.specific.SpecificData;
import org.apache.avro.util.Utf8;
import org.apache.avro.message.BinaryMessageEncoder;
import org.apache.avro.message.BinaryMessageDecoder;
import org.apache.avro.message.SchemaStore;

/** A temporarily suppressed alarm override */
@org.apache.avro.specific.AvroGenerated
public class ShelvedOverride extends org.apache.avro.specific.SpecificRecordBase implements org.apache.avro.specific.SpecificRecord {
  private static final long serialVersionUID = 4075023404685486179L;


  public static final org.apache.avro.Schema SCHEMA$ = new org.apache.avro.Schema.Parser().parse("{\"type\":\"record\",\"name\":\"ShelvedOverride\",\"namespace\":\"org.jlab.jaws.entity\",\"doc\":\"A temporarily suppressed alarm override\",\"fields\":[{\"name\":\"oneshot\",\"type\":\"boolean\",\"doc\":\"Indicates whether this shelved alarm unshelves when active; otherwise considered a continuous shelve and clears only upon expiration or manual operator intervention\",\"default\":false},{\"name\":\"expiration\",\"type\":\"long\",\"doc\":\"Unix timestamp of milliseconds since Epoch of Jan 1. 1970 - Timestamp denotes when this shelved alarm should expire\"},{\"name\":\"reason\",\"type\":{\"type\":\"enum\",\"name\":\"ShelvedReason\",\"doc\":\"Enumeration of possible reasons\",\"symbols\":[\"Stale_Alarm\",\"Chattering_Fleeting_Alarm\",\"Other\"]},\"doc\":\"Reason this alarm is shelved\"},{\"name\":\"comments\",\"type\":[\"null\",{\"type\":\"string\",\"avro.java.string\":\"String\"}],\"doc\":\"Operator explanation\"}]}");
  public static org.apache.avro.Schema getClassSchema() { return SCHEMA$; }

  private static final SpecificData MODEL$ = new SpecificData();

  private static final BinaryMessageEncoder ENCODER =
      new BinaryMessageEncoder<>(MODEL$, SCHEMA$);

  private static final BinaryMessageDecoder DECODER =
      new BinaryMessageDecoder<>(MODEL$, SCHEMA$);

  /**
   * Return the BinaryMessageEncoder instance used by this class.
   * @return the message encoder used by this class
   */
  public static BinaryMessageEncoder getEncoder() {
    return ENCODER;
  }

  /**
   * Return the BinaryMessageDecoder instance used by this class.
   * @return the message decoder used by this class
   */
  public static BinaryMessageDecoder getDecoder() {
    return DECODER;
  }

  /**
   * Create a new BinaryMessageDecoder instance for this class that uses the specified {@link SchemaStore}.
   * @param resolver a {@link SchemaStore} used to find schemas by fingerprint
   * @return a BinaryMessageDecoder instance for this class backed by the given SchemaStore
   */
  public static BinaryMessageDecoder createDecoder(SchemaStore resolver) {
    return new BinaryMessageDecoder<>(MODEL$, SCHEMA$, resolver);
  }

  /**
   * Serializes this ShelvedOverride to a ByteBuffer.
   * @return a buffer holding the serialized data for this instance
   * @throws java.io.IOException if this instance could not be serialized
   */
  public java.nio.ByteBuffer toByteBuffer() throws java.io.IOException {
    return ENCODER.encode(this);
  }

  /**
   * Deserializes a ShelvedOverride from a ByteBuffer.
   * @param b a byte buffer holding serialized data for an instance of this class
   * @return a ShelvedOverride instance decoded from the given buffer
   * @throws java.io.IOException if the given bytes could not be deserialized into an instance of this class
   */
  public static ShelvedOverride fromByteBuffer(
      java.nio.ByteBuffer b) throws java.io.IOException {
    return DECODER.decode(b);
  }

  /** Indicates whether this shelved alarm unshelves when active; otherwise considered a continuous shelve and clears only upon expiration or manual operator intervention */
  private boolean oneshot;
  /** Unix timestamp of milliseconds since Epoch of Jan 1. 1970 - Timestamp denotes when this shelved alarm should expire */
  private long expiration;
  /** Reason this alarm is shelved */
  private org.jlab.jaws.entity.ShelvedReason reason;
  /** Operator explanation */
  private java.lang.String comments;

  /**
   * Default constructor.  Note that this does not initialize fields
   * to their default values from the schema.  If that is desired then
   * one should use newBuilder().
   */
  public ShelvedOverride() {}

  /**
   * All-args constructor.
   * @param oneshot Indicates whether this shelved alarm unshelves when active; otherwise considered a continuous shelve and clears only upon expiration or manual operator intervention
   * @param expiration Unix timestamp of milliseconds since Epoch of Jan 1. 1970 - Timestamp denotes when this shelved alarm should expire
   * @param reason Reason this alarm is shelved
   * @param comments Operator explanation
   */
  public ShelvedOverride(java.lang.Boolean oneshot, java.lang.Long expiration, org.jlab.jaws.entity.ShelvedReason reason, java.lang.String comments) {
    this.oneshot = oneshot;
    this.expiration = expiration;
    this.reason = reason;
    this.comments = comments;
  }

  @Override
  public org.apache.avro.specific.SpecificData getSpecificData() { return MODEL$; }

  @Override
  public org.apache.avro.Schema getSchema() { return SCHEMA$; }

  // Used by DatumWriter.  Applications should not call.
  @Override
  public java.lang.Object get(int field$) {
    switch (field$) {
    case 0: return oneshot;
    case 1: return expiration;
    case 2: return reason;
    case 3: return comments;
    default: throw new IndexOutOfBoundsException("Invalid index: " + field$);
    }
  }

  // Used by DatumReader.  Applications should not call.
  @Override
  @SuppressWarnings(value="unchecked")
  public void put(int field$, java.lang.Object value$) {
    switch (field$) {
    case 0: oneshot = (java.lang.Boolean)value$; break;
    case 1: expiration = (java.lang.Long)value$; break;
    case 2: reason = (org.jlab.jaws.entity.ShelvedReason)value$; break;
    case 3: comments = value$ != null ? value$.toString() : null; break;
    default: throw new IndexOutOfBoundsException("Invalid index: " + field$);
    }
  }

  /**
   * Gets the value of the 'oneshot' field.
   * @return Indicates whether this shelved alarm unshelves when active; otherwise considered a continuous shelve and clears only upon expiration or manual operator intervention
   */
  public boolean getOneshot() {
    return oneshot;
  }


  /**
   * Sets the value of the 'oneshot' field.
   * Indicates whether this shelved alarm unshelves when active; otherwise considered a continuous shelve and clears only upon expiration or manual operator intervention
   * @param value the value to set.
   */
  public void setOneshot(boolean value) {
    this.oneshot = value;
  }

  /**
   * Gets the value of the 'expiration' field.
   * @return Unix timestamp of milliseconds since Epoch of Jan 1. 1970 - Timestamp denotes when this shelved alarm should expire
   */
  public long getExpiration() {
    return expiration;
  }


  /**
   * Sets the value of the 'expiration' field.
   * Unix timestamp of milliseconds since Epoch of Jan 1. 1970 - Timestamp denotes when this shelved alarm should expire
   * @param value the value to set.
   */
  public void setExpiration(long value) {
    this.expiration = value;
  }

  /**
   * Gets the value of the 'reason' field.
   * @return Reason this alarm is shelved
   */
  public org.jlab.jaws.entity.ShelvedReason getReason() {
    return reason;
  }


  /**
   * Sets the value of the 'reason' field.
   * Reason this alarm is shelved
   * @param value the value to set.
   */
  public void setReason(org.jlab.jaws.entity.ShelvedReason value) {
    this.reason = value;
  }

  /**
   * Gets the value of the 'comments' field.
   * @return Operator explanation
   */
  public java.lang.String getComments() {
    return comments;
  }


  /**
   * Sets the value of the 'comments' field.
   * Operator explanation
   * @param value the value to set.
   */
  public void setComments(java.lang.String value) {
    this.comments = value;
  }

  /**
   * Creates a new ShelvedOverride RecordBuilder.
   * @return A new ShelvedOverride RecordBuilder
   */
  public static org.jlab.jaws.entity.ShelvedOverride.Builder newBuilder() {
    return new org.jlab.jaws.entity.ShelvedOverride.Builder();
  }

  /**
   * Creates a new ShelvedOverride RecordBuilder by copying an existing Builder.
   * @param other The existing builder to copy.
   * @return A new ShelvedOverride RecordBuilder
   */
  public static org.jlab.jaws.entity.ShelvedOverride.Builder newBuilder(org.jlab.jaws.entity.ShelvedOverride.Builder other) {
    if (other == null) {
      return new org.jlab.jaws.entity.ShelvedOverride.Builder();
    } else {
      return new org.jlab.jaws.entity.ShelvedOverride.Builder(other);
    }
  }

  /**
   * Creates a new ShelvedOverride RecordBuilder by copying an existing ShelvedOverride instance.
   * @param other The existing instance to copy.
   * @return A new ShelvedOverride RecordBuilder
   */
  public static org.jlab.jaws.entity.ShelvedOverride.Builder newBuilder(org.jlab.jaws.entity.ShelvedOverride other) {
    if (other == null) {
      return new org.jlab.jaws.entity.ShelvedOverride.Builder();
    } else {
      return new org.jlab.jaws.entity.ShelvedOverride.Builder(other);
    }
  }

  /**
   * RecordBuilder for ShelvedOverride instances.
   */
  @org.apache.avro.specific.AvroGenerated
  public static class Builder extends org.apache.avro.specific.SpecificRecordBuilderBase
    implements org.apache.avro.data.RecordBuilder {

    /** Indicates whether this shelved alarm unshelves when active; otherwise considered a continuous shelve and clears only upon expiration or manual operator intervention */
    private boolean oneshot;
    /** Unix timestamp of milliseconds since Epoch of Jan 1. 1970 - Timestamp denotes when this shelved alarm should expire */
    private long expiration;
    /** Reason this alarm is shelved */
    private org.jlab.jaws.entity.ShelvedReason reason;
    /** Operator explanation */
    private java.lang.String comments;

    /** Creates a new Builder */
    private Builder() {
      super(SCHEMA$, MODEL$);
    }

    /**
     * Creates a Builder by copying an existing Builder.
     * @param other The existing Builder to copy.
     */
    private Builder(org.jlab.jaws.entity.ShelvedOverride.Builder other) {
      super(other);
      if (isValidValue(fields()[0], other.oneshot)) {
        this.oneshot = data().deepCopy(fields()[0].schema(), other.oneshot);
        fieldSetFlags()[0] = other.fieldSetFlags()[0];
      }
      if (isValidValue(fields()[1], other.expiration)) {
        this.expiration = data().deepCopy(fields()[1].schema(), other.expiration);
        fieldSetFlags()[1] = other.fieldSetFlags()[1];
      }
      if (isValidValue(fields()[2], other.reason)) {
        this.reason = data().deepCopy(fields()[2].schema(), other.reason);
        fieldSetFlags()[2] = other.fieldSetFlags()[2];
      }
      if (isValidValue(fields()[3], other.comments)) {
        this.comments = data().deepCopy(fields()[3].schema(), other.comments);
        fieldSetFlags()[3] = other.fieldSetFlags()[3];
      }
    }

    /**
     * Creates a Builder by copying an existing ShelvedOverride instance
     * @param other The existing instance to copy.
     */
    private Builder(org.jlab.jaws.entity.ShelvedOverride other) {
      super(SCHEMA$, MODEL$);
      if (isValidValue(fields()[0], other.oneshot)) {
        this.oneshot = data().deepCopy(fields()[0].schema(), other.oneshot);
        fieldSetFlags()[0] = true;
      }
      if (isValidValue(fields()[1], other.expiration)) {
        this.expiration = data().deepCopy(fields()[1].schema(), other.expiration);
        fieldSetFlags()[1] = true;
      }
      if (isValidValue(fields()[2], other.reason)) {
        this.reason = data().deepCopy(fields()[2].schema(), other.reason);
        fieldSetFlags()[2] = true;
      }
      if (isValidValue(fields()[3], other.comments)) {
        this.comments = data().deepCopy(fields()[3].schema(), other.comments);
        fieldSetFlags()[3] = true;
      }
    }

    /**
      * Gets the value of the 'oneshot' field.
      * Indicates whether this shelved alarm unshelves when active; otherwise considered a continuous shelve and clears only upon expiration or manual operator intervention
      * @return The value.
      */
    public boolean getOneshot() {
      return oneshot;
    }


    /**
      * Sets the value of the 'oneshot' field.
      * Indicates whether this shelved alarm unshelves when active; otherwise considered a continuous shelve and clears only upon expiration or manual operator intervention
      * @param value The value of 'oneshot'.
      * @return This builder.
      */
    public org.jlab.jaws.entity.ShelvedOverride.Builder setOneshot(boolean value) {
      validate(fields()[0], value);
      this.oneshot = value;
      fieldSetFlags()[0] = true;
      return this;
    }

    /**
      * Checks whether the 'oneshot' field has been set.
      * Indicates whether this shelved alarm unshelves when active; otherwise considered a continuous shelve and clears only upon expiration or manual operator intervention
      * @return True if the 'oneshot' field has been set, false otherwise.
      */
    public boolean hasOneshot() {
      return fieldSetFlags()[0];
    }


    /**
      * Clears the value of the 'oneshot' field.
      * Indicates whether this shelved alarm unshelves when active; otherwise considered a continuous shelve and clears only upon expiration or manual operator intervention
      * @return This builder.
      */
    public org.jlab.jaws.entity.ShelvedOverride.Builder clearOneshot() {
      fieldSetFlags()[0] = false;
      return this;
    }

    /**
      * Gets the value of the 'expiration' field.
      * Unix timestamp of milliseconds since Epoch of Jan 1. 1970 - Timestamp denotes when this shelved alarm should expire
      * @return The value.
      */
    public long getExpiration() {
      return expiration;
    }


    /**
      * Sets the value of the 'expiration' field.
      * Unix timestamp of milliseconds since Epoch of Jan 1. 1970 - Timestamp denotes when this shelved alarm should expire
      * @param value The value of 'expiration'.
      * @return This builder.
      */
    public org.jlab.jaws.entity.ShelvedOverride.Builder setExpiration(long value) {
      validate(fields()[1], value);
      this.expiration = value;
      fieldSetFlags()[1] = true;
      return this;
    }

    /**
      * Checks whether the 'expiration' field has been set.
      * Unix timestamp of milliseconds since Epoch of Jan 1. 1970 - Timestamp denotes when this shelved alarm should expire
      * @return True if the 'expiration' field has been set, false otherwise.
      */
    public boolean hasExpiration() {
      return fieldSetFlags()[1];
    }


    /**
      * Clears the value of the 'expiration' field.
      * Unix timestamp of milliseconds since Epoch of Jan 1. 1970 - Timestamp denotes when this shelved alarm should expire
      * @return This builder.
      */
    public org.jlab.jaws.entity.ShelvedOverride.Builder clearExpiration() {
      fieldSetFlags()[1] = false;
      return this;
    }

    /**
      * Gets the value of the 'reason' field.
      * Reason this alarm is shelved
      * @return The value.
      */
    public org.jlab.jaws.entity.ShelvedReason getReason() {
      return reason;
    }


    /**
      * Sets the value of the 'reason' field.
      * Reason this alarm is shelved
      * @param value The value of 'reason'.
      * @return This builder.
      */
    public org.jlab.jaws.entity.ShelvedOverride.Builder setReason(org.jlab.jaws.entity.ShelvedReason value) {
      validate(fields()[2], value);
      this.reason = value;
      fieldSetFlags()[2] = true;
      return this;
    }

    /**
      * Checks whether the 'reason' field has been set.
      * Reason this alarm is shelved
      * @return True if the 'reason' field has been set, false otherwise.
      */
    public boolean hasReason() {
      return fieldSetFlags()[2];
    }


    /**
      * Clears the value of the 'reason' field.
      * Reason this alarm is shelved
      * @return This builder.
      */
    public org.jlab.jaws.entity.ShelvedOverride.Builder clearReason() {
      reason = null;
      fieldSetFlags()[2] = false;
      return this;
    }

    /**
      * Gets the value of the 'comments' field.
      * Operator explanation
      * @return The value.
      */
    public java.lang.String getComments() {
      return comments;
    }


    /**
      * Sets the value of the 'comments' field.
      * Operator explanation
      * @param value The value of 'comments'.
      * @return This builder.
      */
    public org.jlab.jaws.entity.ShelvedOverride.Builder setComments(java.lang.String value) {
      validate(fields()[3], value);
      this.comments = value;
      fieldSetFlags()[3] = true;
      return this;
    }

    /**
      * Checks whether the 'comments' field has been set.
      * Operator explanation
      * @return True if the 'comments' field has been set, false otherwise.
      */
    public boolean hasComments() {
      return fieldSetFlags()[3];
    }


    /**
      * Clears the value of the 'comments' field.
      * Operator explanation
      * @return This builder.
      */
    public org.jlab.jaws.entity.ShelvedOverride.Builder clearComments() {
      comments = null;
      fieldSetFlags()[3] = false;
      return this;
    }

    @Override
    @SuppressWarnings("unchecked")
    public ShelvedOverride build() {
      try {
        ShelvedOverride record = new ShelvedOverride();
        record.oneshot = fieldSetFlags()[0] ? this.oneshot : (java.lang.Boolean) defaultValue(fields()[0]);
        record.expiration = fieldSetFlags()[1] ? this.expiration : (java.lang.Long) defaultValue(fields()[1]);
        record.reason = fieldSetFlags()[2] ? this.reason : (org.jlab.jaws.entity.ShelvedReason) defaultValue(fields()[2]);
        record.comments = fieldSetFlags()[3] ? this.comments : (java.lang.String) defaultValue(fields()[3]);
        return record;
      } catch (org.apache.avro.AvroMissingFieldException e) {
        throw e;
      } catch (java.lang.Exception e) {
        throw new org.apache.avro.AvroRuntimeException(e);
      }
    }
  }

  @SuppressWarnings("unchecked")
  private static final org.apache.avro.io.DatumWriter
    WRITER$ = (org.apache.avro.io.DatumWriter)MODEL$.createDatumWriter(SCHEMA$);

  @Override public void writeExternal(java.io.ObjectOutput out)
    throws java.io.IOException {
    WRITER$.write(this, SpecificData.getEncoder(out));
  }

  @SuppressWarnings("unchecked")
  private static final org.apache.avro.io.DatumReader
    READER$ = (org.apache.avro.io.DatumReader)MODEL$.createDatumReader(SCHEMA$);

  @Override public void readExternal(java.io.ObjectInput in)
    throws java.io.IOException {
    READER$.read(this, SpecificData.getDecoder(in));
  }

  @Override protected boolean hasCustomCoders() { return true; }

  @Override public void customEncode(org.apache.avro.io.Encoder out)
    throws java.io.IOException
  {
    out.writeBoolean(this.oneshot);

    out.writeLong(this.expiration);

    out.writeEnum(this.reason.ordinal());

    if (this.comments == null) {
      out.writeIndex(0);
      out.writeNull();
    } else {
      out.writeIndex(1);
      out.writeString(this.comments);
    }

  }

  @Override public void customDecode(org.apache.avro.io.ResolvingDecoder in)
    throws java.io.IOException
  {
    org.apache.avro.Schema.Field[] fieldOrder = in.readFieldOrderIfDiff();
    if (fieldOrder == null) {
      this.oneshot = in.readBoolean();

      this.expiration = in.readLong();

      this.reason = org.jlab.jaws.entity.ShelvedReason.values()[in.readEnum()];

      if (in.readIndex() != 1) {
        in.readNull();
        this.comments = null;
      } else {
        this.comments = in.readString();
      }

    } else {
      for (int i = 0; i < 4; i++) {
        switch (fieldOrder[i].pos()) {
        case 0:
          this.oneshot = in.readBoolean();
          break;

        case 1:
          this.expiration = in.readLong();
          break;

        case 2:
          this.reason = org.jlab.jaws.entity.ShelvedReason.values()[in.readEnum()];
          break;

        case 3:
          if (in.readIndex() != 1) {
            in.readNull();
            this.comments = null;
          } else {
            this.comments = in.readString();
          }
          break;

        default:
          throw new java.io.IOException("Corrupt ResolvingDecoder.");
        }
      }
    }
  }
}














© 2015 - 2025 Weber Informatics LLC | Privacy Policy