Context.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 com.google.wave.api;

/**
 * Enumeration that represents the context that the robot needs to provide when
 * calling the Robot's event handler. This is specified in the Robot's
 * capabilities.xml.
 */
public enum Context {
  /** The first blip in the root thread. */
  ROOT,
  /** The preceeding blip in the thread, or parent blip for a new thread. */
  PARENT,
  /** The blips in the same thread. */
  SIBLINGS,
  /** The next blip in the thread and the first blip in each reply. */
  CHILDREN,
  /** Just one blip. */
  SELF,
  /** All blips .*/
  ALL;

  public static Context valueOfIgnoreCase(String name) {
    return valueOf(name.toUpperCase());
  }
}