nl.topicus.jdbc.shaded.com.google.instrumentation.stats.BucketBoundaries Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spanner-jdbc Show documentation

JDBC Driver for Google Cloud Spanner

There is a newer version: 1.1.6

/*
 * Copyright 2017, Google Inc.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in nl.topicus.jdbc.shaded.com.liance with the License.
 * You may obtain a copy of the License at
 *     http://www.apache.nl.topicus.jdbc.shaded.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 nl.topicus.jdbc.shaded.com.google.instrumentation.stats;

import static nl.topicus.jdbc.shaded.com.google.nl.topicus.jdbc.shaded.com.on.base.Preconditions.checkArgument;
import static nl.topicus.jdbc.shaded.com.google.nl.topicus.jdbc.shaded.com.on.base.Preconditions.checkNotNull;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 * The optional histogram bucket boundaries for a {@link Distribution}.
 */
public final class BucketBoundaries {
  private final List bucketBoundaries;

  /**
   * @param bucketBoundaries the boundaries for the buckets in the underlying {@link Distribution}.
   * @return a new {@code BucketBoundaries} with the specified boundaries.
   * @throws NullPointerException if {@code bucketBoundaries} is null.
   * @throws IllegalArgumentException if {@code bucketBoundaries} is not sorted, or has zero length.
   */
  public static final BucketBoundaries create(List bucketBoundaries) {
    checkNotNull(bucketBoundaries, "bucketBoundaries list should not be null.");
    List bucketBoundariesCopy = new ArrayList(bucketBoundaries);  // Deep copy.
    checkArgument(!bucketBoundariesCopy.isEmpty(), "Zero length bucket boundaries");
    double lower = bucketBoundariesCopy.get(0);
    for (int i = 1; i < bucketBoundariesCopy.size(); i++) {
      double next = bucketBoundariesCopy.get(i);
      checkArgument(lower < next, "Bucket boundaries not sorted.");
      lower = next;
    }

    return new BucketBoundaries(Collections.unmodifiableList(bucketBoundariesCopy));
  }

  /**
   * @return a list of histogram bucket boundaries.
   */
  public final List getBoundaries() {
    return bucketBoundaries;
  }

  private BucketBoundaries(List bucketBoundaries) {
    this.bucketBoundaries = bucketBoundaries;
  }
}