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.webserver;
020
021import org.apache.reef.driver.evaluator.EvaluatorDescriptor;
022import org.apache.reef.tang.annotations.DefaultImplementation;
023
024import java.util.Map;
025
026/**
027 * Interface for EvaluatorListSerializer.
028 */
029@DefaultImplementation(AvroEvaluatorListSerializer.class)
030public interface EvaluatorListSerializer {
031  /**
032   * Build AvroEvaluatorList object.
033   *
034   * @param evaluatorMap
035   * @param totalEvaluators
036   * @param startTime
037   * @return
038   */
039  AvroEvaluatorList toAvro(final Map<String, EvaluatorDescriptor> evaluatorMap,
040                           final int totalEvaluators,
041                           final String startTime);
042
043  /**
044   * Convert AvroEvaluatorList to JSon string.
045   *
046   * @param avroEvaluatorList
047   * @return
048   */
049  String toString(final AvroEvaluatorList avroEvaluatorList);
050}