001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.reef.runtime.common.client.parameters;
020
021import org.apache.reef.annotations.audience.ClientSide;
022import org.apache.reef.tang.annotations.Name;
023import org.apache.reef.tang.annotations.NamedParameter;
024
025/**
026 * A Tang named parameter that indicates whether or not a client (handler for the various Job events) is present.
027 */
028@ClientSide
029@NamedParameter(doc = "Indicates whether or not a client is present", default_value = ClientPresent.NO)
030public final class ClientPresent implements Name<String> {
031  public static final String YES = "YES";
032  public static final String NO = "NO";
033
034  /**
035   * Empty private constructor to prohibit instantiation of utility class.
036   */
037  private ClientPresent() {
038  }
039}