/**
 * Copyright 2008 Google Inc.
 *
 * 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.waveprotocol.wave.model.operation.wave;

import org.waveprotocol.wave.model.wave.data.BlipData;

/**
 * Operation class for submitting a blip.
 *
 */
public final class SubmitBlip extends InvertibleBlipOperation {

  private static final int HASH = SubmitBlip.class.getName().hashCode();

  /**
   * Constructs a submit operation.
   */
  public SubmitBlip(WaveletOperationContext context) {
    super(context);
  }

  /**
   * Applies to a target blip by submitting it.
   */
  @Override
  protected void doApply(BlipData target) {
    target.submit();
  }

  @Override
  protected void doUpdate(BlipData target) {
    // Do nothing
  }

  @Override
  public BlipOperation invert(WaveletOperationContext newContext) {
    return new SubmitBlip(newContext);
  }

  @Override
  public void acceptVisitor(BlipOperationVisitor visitor) {
    visitor.visitSubmitBlip(this);
  }

  @Override
  public boolean updatesBlipMetadata(String blipId) {
    return false;
  }

  @Override
  public String toString() {
    return "submit";
  }

  @Override
  public int hashCode() {
    /*
     * NOTE(user): We may be able to get rid of this hash function in the
     * future if this class becomes a singleton.
     */
    return HASH;
  }

  @Override
  public boolean equals(Object obj) {
    /*
     * NOTE(user): We're ignoring context in equality comparison. The plan is
     * to remove context from all operations in the future.
     */
    return obj instanceof SubmitBlip;
  }
}