You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2019/09/13 17:10:56 UTC

[commons-lang] 03/03: Document interfaces with @FunctionalInterface.

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-lang.git

commit aac260f84c568e096cb4b24f9b35499cc56a6019
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Sep 13 11:47:47 2019 -0400

    Document interfaces with @FunctionalInterface.
    
    Javadoc.
---
 src/main/java/org/apache/commons/lang3/builder/Builder.java     | 1 +
 src/main/java/org/apache/commons/lang3/builder/Diffable.java    | 1 +
 src/main/java/org/apache/commons/lang3/reflect/TypeLiteral.java | 1 +
 src/main/java/org/apache/commons/lang3/reflect/Typed.java       | 5 ++++-
 4 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/src/main/java/org/apache/commons/lang3/builder/Builder.java b/src/main/java/org/apache/commons/lang3/builder/Builder.java
index 3e69afb..ad4edce 100644
--- a/src/main/java/org/apache/commons/lang3/builder/Builder.java
+++ b/src/main/java/org/apache/commons/lang3/builder/Builder.java
@@ -76,6 +76,7 @@ package org.apache.commons.lang3.builder;
  *
  * @since 3.0
  */
+@FunctionalInterface
 public interface Builder<T> {
 
     /**
diff --git a/src/main/java/org/apache/commons/lang3/builder/Diffable.java b/src/main/java/org/apache/commons/lang3/builder/Diffable.java
index 1cb7982..71ffe31 100644
--- a/src/main/java/org/apache/commons/lang3/builder/Diffable.java
+++ b/src/main/java/org/apache/commons/lang3/builder/Diffable.java
@@ -39,6 +39,7 @@ package org.apache.commons.lang3.builder;
  * @param <T> the type of objects that this object may be differentiated against
  * @since 3.3
  */
+@FunctionalInterface
 public interface Diffable<T> {
 
     /**
diff --git a/src/main/java/org/apache/commons/lang3/reflect/TypeLiteral.java b/src/main/java/org/apache/commons/lang3/reflect/TypeLiteral.java
index cef7ebd..e1e2898 100644
--- a/src/main/java/org/apache/commons/lang3/reflect/TypeLiteral.java
+++ b/src/main/java/org/apache/commons/lang3/reflect/TypeLiteral.java
@@ -69,6 +69,7 @@ import org.apache.commons.lang3.Validate;
  *   &lt;T&gt; T obtain(Typed&lt;T&gt; typed, ...);
  * </pre>
  *
+ * @param <T> the type
  * @since 3.2
  */
 public abstract class TypeLiteral<T> implements Typed<T> {
diff --git a/src/main/java/org/apache/commons/lang3/reflect/Typed.java b/src/main/java/org/apache/commons/lang3/reflect/Typed.java
index b21b51b..f8432d5 100644
--- a/src/main/java/org/apache/commons/lang3/reflect/Typed.java
+++ b/src/main/java/org/apache/commons/lang3/reflect/Typed.java
@@ -20,13 +20,16 @@ import java.lang.reflect.Type;
 
 /**
  * Generalization of "has a type."
+ *
+ * @param <T> the type
  * @see TypeLiteral
  * @since 3.2
  */
+@FunctionalInterface
 public interface Typed<T> {
 
     /**
-     * Get the {@link Type} represented by this entity.
+     * Gets the {@link Type} represented by this entity.
      *
      * @return Type
      */