This project has retired. For details please refer to its Attic page.
Source code
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.wake.profiler;
020
021import org.apache.reef.tang.Injector;
022import org.apache.reef.tang.annotations.Name;
023import org.apache.reef.tang.annotations.NamedParameter;
024import org.apache.reef.tang.exceptions.InjectionException;
025
026/**
027 * A class that contains parameters and states for wake profiler.
028 */
029public final class ProfilerState {
030
031  private ProfilerState() {}
032
033  /**
034   * Parameter to enable Wake network profiling. By default profiling is disabled.
035   */
036  @NamedParameter(doc = "If true, profiling will be enabled", short_name = "profiling", default_value = "false")
037  private static final class ProfilingEnabled implements Name<Boolean> { }
038
039  /**
040   * Gets the class of the NamedParameter ProfilingEnabled.
041   *
042   * @return Class of ProflingEnabled which should be Name<Boolean>
043   */
044  private static Class<? extends Name<Boolean>> getProfilingEnabledClass() {
045    return ProfilingEnabled.class;
046  }
047
048  /**
049   * Checks if profiling is enabled.
050   *
051   * @param injector the tang injector that stores value of ProfilingEnabled.
052   * @return true if profiling is enabled
053   * @throws InjectionException if name resolution fails
054   */
055  public static boolean isProfilingEnabled(final Injector injector) throws InjectionException {
056    return injector.getNamedInstance(getProfilingEnabledClass());
057  }
058}