AbstractSampleRate.java

/*
 * Copyright 2016-present Facebook, Inc.
 *
 * Licensed 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 com.facebook.buck.util;

import com.facebook.buck.util.immutables.BuckStyleImmutable;
import com.google.common.base.Preconditions;
import org.immutables.value.Value;

/**
 * Holds a probability between 0 to 100 inclusively. Performs the checks that the value is within
 * those limits.
 */
@Value.Immutable
@BuckStyleImmutable
abstract class AbstractSampleRate {
  @Value.Parameter
  abstract float getSampleRate();

  @Value.Check
  protected void check() {
    Preconditions.checkArgument(getSampleRate() >= 0.0f);
    Preconditions.checkArgument(getSampleRate() <= 1.0f);
  }
}