no.digipost.tuple.ViewableAsPentuple Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of digg Show documentation

Some stellar general purpose utils.

There is a newer version: 0.36

/*
 * Copyright (C) Posten Norge AS
 *
 * 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 no.digipost.tuple;

/**
 * A type which may be viewed as a composite of five values, i.e. a {@link Pentuple}.
 *
 * @param  The type of the first value.
 * @param  The type of the second value.
 * @param  The type of the third value.
 * @param  The type of the fourth value.
 * @param  The type of the fifth value.
 */
@FunctionalInterface
public interface ViewableAsPentuple {

    /**
     * @return The {@link Pentuple} view of this object.
     */
    Pentuple asPentuple();

}