org.dominokit.domino.ui.utils.HasCounter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of domino-ui Show documentation

There is a newer version: 2.0.3

/*
 * Copyright © 2019 Dominokit
 *
 * 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 org.dominokit.domino.ui.utils;

/**
 * The {@code HasCounter} interface defines methods for managing counters and formatting their
 * display.
 *
 * @param  The type of the component that can have a counter.
 */
public interface HasCounter {

  /**
   * Updates the counter and displays it with a maximum count.
   *
   * @param count The current count.
   * @param maxCount The maximum count allowed.
   * @return The component with the counter updated.
   */
  T updateCounter(int count, int maxCount);

  /**
   * Gets the maximum count allowed for the component.
   *
   * @return The maximum count allowed.
   */
  int getMaxCount();

  /** A functional interface for formatting the count and maximum count for display. */
  interface CountFormatter {

    /**
     * Formats the count and maximum count for display.
     *
     * @param count The current count.
     * @param maxCount The maximum count allowed.
     * @return A formatted string representing the count and maximum count.
     */
    String format(int count, int maxCount);
  }
}