// Copyright (C) 2022 The Android Open Source Project
//
// 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.google.gerrit.metrics;

import java.time.Duration;

/** Configuration of the Metrics' reservoir type and size. */
public interface MetricsReservoirConfig {

  /** @return the reservoir type. */
  ReservoirType reservoirType();

  /** @return the reservoir window duration. */
  Duration reservoirWindow();

  /** @return the number of samples that the reservoir can contain */
  int reservoirSize();

  /** @return the alpha parameter of the ExponentiallyDecaying reservoir */
  double reservoirAlpha();
}

// Copyright (C) 2022 The Android Open Source Project
//
// 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.google.gerrit.metrics;

import java.time.Duration;

/** Configuration of the Metrics' reservoir type and size. */
public interface MetricsReservoirConfig {

  /** Returns the reservoir type. */
  ReservoirType reservoirType();

  /** Returns the reservoir window duration. */
  Duration reservoirWindow();

  /** Returns the number of samples that the reservoir can contain */
  int reservoirSize();

  /** Returns the alpha parameter of the ExponentiallyDecaying reservoir */
  double reservoirAlpha();
}

Fix javadoc summary for Google Java Style
Fix javadoc summary for Google Java Style

The summary shouldn't use @return and should use "Returns".

[1] https://google.github.io/styleguide/javaguide.html#s7.2-summary-fragment

Change-Id: I631f0be5c048c2f93d62993c41583fb382d714ac
Release-Notes: skip
