lang/java/reef-common/src/main/java/org/apache/reef/runtime/common/client/parameters/ClientPresent.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.reef.runtime.common.client.parameters;

import org.apache.reef.annotations.audience.ClientSide;
import org.apache.reef.tang.annotations.Name;
import org.apache.reef.tang.annotations.NamedParameter;

/**
 * A Tang named parameter that indicates whether or not a client (handler for the various Job events) is present.
 */
@ClientSide
@NamedParameter(doc = "Indicates whether or not a client is present", default_value = ClientPresent.NO)
public final class ClientPresent implements Name<String> {
  public static final String YES = "YES";
  public static final String NO = "NO";

  /**
   * Empty private constructor to prohibit instantiation of utility class.
   */
  private ClientPresent() {
  }
}