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.driver.parameters;
020
021import org.apache.reef.runtime.common.launch.parameters.ErrorHandlerRID;
022import org.apache.reef.tang.annotations.Name;
023import org.apache.reef.tang.annotations.NamedParameter;
024
025/**
026 * The client remote identifier.
027 */
028@NamedParameter(doc = "The client remote identifier.", default_value = ClientRemoteIdentifier.NONE)
029public final class ClientRemoteIdentifier implements Name<String> {
030  /**
031   * Indicates that there is no Client.
032   */
033  // TODO[JIRA REEF-837]: Replace comparisons with this constant with interface with different implementations
034  public static final String NONE = ErrorHandlerRID.NONE;
035
036  /**
037   * Empty private constructor to prohibit instantiation of utility class.
038   */
039  private ClientRemoteIdentifier() {
040  }
041}