swim.util.PairBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swim-util Show documentation

Extended collection, iterator, and builder interfaces, lightweight cache sets and maps, and other foundational utilities

There is a newer version: 4.3.15

Show newest version

// Copyright 2015-2019 SWIM.AI 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 swim.util;

/**
 * Type that accumulates pairs of input values, and binds an output result of
 * type {@code O}.
 */
public interface PairBuilder {
  /**
   * Adds an input pair to this builder, returning {@code true} if the state
   * of the builder changed.
   */
  boolean add(K key, V value);

  /**
   * Returns the output result of this builder.
   */
  O bind();
}