jdk/src/share/classes/java/util/function/BooleanSupplier.java
author mduigou
Tue, 23 Jul 2013 13:20:11 -0700
changeset 19040 7b25fde2a4ed
parent 17695 032254f2467b
permissions -rw-r--r--
8019840: Spec updates for java.util.function Reviewed-by: mduigou, chegar Contributed-by: brian.goetz@oracle.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     1
/*
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     2
 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     4
 *
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    10
 *
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    15
 * accompanied this code).
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    16
 *
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    20
 *
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    23
 * questions.
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    24
 */
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    25
package java.util.function;
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    26
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    27
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    28
/**
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    29
 * Represents a supplier of {@code boolean}-valued results.  This is the
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    30
 * {@code boolean}-producing primitive specialization of {@link Supplier}.
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    31
 *
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    32
 * <p>There is no requirement that a new or distinct result be returned each
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    33
 * time the supplier is invoked.
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    34
 *
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    35
 * <p>This is a <a href="package-summary.html">functional interface</a>
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    36
 * whose functional method is {@link #getAsBoolean()}.
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    37
 *
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    38
 * @see Supplier
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    39
 * @since 1.8
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    40
 */
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    41
@FunctionalInterface
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    42
public interface BooleanSupplier {
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    43
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    44
    /**
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    45
     * Gets a result.
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    46
     *
19040
7b25fde2a4ed 8019840: Spec updates for java.util.function
mduigou
parents: 17695
diff changeset
    47
     * @return a result
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    48
     */
17695
032254f2467b 8004015: Additional static and instance utils for functional interfaces.
mduigou
parents: 16011
diff changeset
    49
    boolean getAsBoolean();
16011
890a7ed97f6c 8004561: Additional functional interfaces, extension methods and name changes
mduigou
parents:
diff changeset
    50
}