Play stubs improvements, cleanup and return values

torque59 · torque59 · commit 4384f78595ab · 2021-03-02T16:50:16.000+05:30
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/Application.java b/java/ql/test/stubs/playframework-2.6.x/play/Application.java
@@ -7,82 +7,25 @@
 import java.io.InputStream;
 import java.net.URL;
 
-//import play.inject.Injector; -> Scala stuff
-//import play.libs.Scala;
-
-/**
- * A Play application.
- *
- * Application creation is handled by the framework engine.
- */
 public interface Application {
 
-    /**
-     * Get the underlying Scala application.
-     *
-     * @
-     */
-    //play.api.Application getWrappedApplication();
-
-    /**
-     * Get the application configuration.
-     *
-     * @
-     */
-    //Configuration configuration();
-
-    /**
-     * Get the injector for this application.
-     *
-     * @
-     */
-    //Injector injector();
-
-    /**
-     * Get the application path.
-     *
-     * @
-     */
-    default File path() {
-    }
-
-    /**
-     * Get the application classloader.
-     *
-     * @
-     */
-    default ClassLoader classloader() {
-
-    }
-
-    /**
-     * Get a file relative to the application root path.
-     *
-     * @param relativePath relative path of the file to fetch
-     * @
-     */
-    default File getFile(String relativePath) {
-
-    }
-
-    /**
-     * Get a resource from the classpath.
-     *
-     * @param relativePath relative path of the resource to fetch
-     * @
-     */
-    default URL resource(String relativePath) {
+  default File path() {
+    return null;
+  }
 
-    }
+  default ClassLoader classloader() {
+    return null;
+  }
 
-    /**
-     * Get a resource stream from the classpath.
-     *
-     * @param relativePath relative path of the resource to fetch
-     * @
-     */
-    default InputStream resourceAsStream(String relativePath) {
+  default File getFile(String relativePath) {
+    return null;
+  }
 
-    }
+  default URL resource(String relativePath) {
+    return null;
+  }
 
-}
+  default InputStream resourceAsStream(String relativePath) {
+    return null;
+  }
+}
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/Play.java b/java/ql/test/stubs/playframework-2.6.x/play/Play.java
@@ -1,20 +1,10 @@
 package play;
 
-/**
- * High-level API to access Play global features.
- *
- * @deprecated Please use dependency injection. Deprecated since 2.5.0.
- */
 @Deprecated
 public class Play {
 
-  /**
-   * @deprecated inject the {@link play.Application} instead. Deprecated since 2.5.0.
-   * @return Deprecated
-   */
   @Deprecated
   public static Application application() {
+    return null;
   }
-
-  //private static play.api.Application privateCurrent() { }
-}
+}
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/api/mvc/Request.java b/java/ql/test/stubs/playframework-2.6.x/play/api/mvc/Request.java
@@ -1,6 +1,3 @@
 package play.api.mvc;
 
-/** Scala dummy */
-public class Request<RequestBody> {
-
-}
+public class Request<RequestBody> {}
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/api/mvc/RequestHeader.java b/java/ql/test/stubs/playframework-2.6.x/play/api/mvc/RequestHeader.java
@@ -1,6 +1,3 @@
 package play.api.mvc;
 
-/** Scala dummy */
-public class RequestHeader {
-
-}
+public class RequestHeader {}
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/api/mvc/StatusHeader.java b/java/ql/test/stubs/playframework-2.6.x/play/api/mvc/StatusHeader.java
@@ -1,6 +1,3 @@
 package play.api.mvc;
 
-/** XML utilities. */
-public class StatusHeader {
-
-}
+public class StatusHeader {}
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/core/j/JavaContextComponents.java b/java/ql/test/stubs/playframework-2.6.x/play/core/j/JavaContextComponents.java
@@ -1,6 +1,3 @@
 package play.core.j;
 
-/** XML utilities. */
-public class JavaContextComponents {
-
-}
+public class JavaContextComponents {}
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/core/j/RequestImpl.java b/java/ql/test/stubs/playframework-2.6.x/play/core/j/RequestImpl.java
@@ -1,6 +1,3 @@
 package play.core.j;
 
-/** Scala dummy */
-public class RequestImpl {
-
-}
+public class RequestImpl {}
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/filters/csrf/AddCSRFToken.java b/java/ql/test/stubs/playframework-2.6.x/play/filters/csrf/AddCSRFToken.java
@@ -5,7 +5,6 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
-/** This action adds a CSRF token to the request and response if not already there. */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.METHOD, ElementType.TYPE})
-public @interface AddCSRFToken {}
+public @interface AddCSRFToken {}
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/http/HttpEntity.java b/java/ql/test/stubs/playframework-2.6.x/play/http/HttpEntity.java
@@ -1,6 +1,3 @@
 package play.http;
 
-/** XML utilities. */
-public abstract class HttpEntity {
-
-}
+public abstract class HttpEntity {}
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/i18n/Lang.java b/java/ql/test/stubs/playframework-2.6.x/play/i18n/Lang.java
@@ -5,14 +5,5 @@
 package play.i18n;
 
 import java.util.*;
-import java.util.stream.Stream;
 
-//import play.Application;
-//import play.libs.*;
-//import scala.collection.immutable.Seq;
-
-import static java.util.stream.Collectors.toList;
-
-/** A Lang supported by the application. */
-public class Lang /* extends play.api.i18n.Lang */ {
-}
+public class Lang /* extends play.api.i18n.Lang */ {}
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/i18n/Langs.java b/java/ql/test/stubs/playframework-2.6.x/play/i18n/Langs.java
@@ -1,5 +1,4 @@
 package play.i18n;
 
 /** A Lang supported by the application. */
-public class Langs {
-}
+public class Langs {}
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/i18n/Messages.java b/java/ql/test/stubs/playframework-2.6.x/play/i18n/Messages.java
@@ -4,10 +4,4 @@
 
 package play.i18n;
 
-/**
- * A Messages will produce messages using a specific language.
- *
- * <p>This interface that is typically backed by MessagesImpl, but does not return MessagesApi.
- */
-public interface Messages {
-}
+public interface Messages {}
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/i18n/MessagesApi.java b/java/ql/test/stubs/playframework-2.6.x/play/i18n/MessagesApi.java
@@ -4,14 +4,4 @@
 
 package play.i18n;
 
-//import javax.inject.Singleton;
-
-/**
- * A Messages will produce messages using a specific language.
- *
- * <p>This interface that is typically backed by MessagesImpl, but does not return MessagesApi.
- */
-//@Singleton
-public class MessagesApi {
-
-}
+public class MessagesApi {}
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/libs/F.java b/java/ql/test/stubs/playframework-2.6.x/play/libs/F.java
@@ -7,9 +7,6 @@
 import java.util.*;
 import java.util.concurrent.*;
 
-// import scala.concurrent.ExecutionContext;
-
-/** Defines a set of functional programming style helpers. */
 public class F {
   public static class Promise<A> { // this is needed for play.libs.F for Play 2.3.x
     public static <A> Promise<A> pure(final A a) {
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/libs/Files.java b/java/ql/test/stubs/playframework-2.6.x/play/libs/Files.java
@@ -4,106 +4,92 @@
 
 package play.libs;
 
-//import javax.inject.Inject;
 import java.io.File;
 import java.nio.file.Path;
 
-/** Contains TemporaryFile and TemporaryFileCreator operations. */
 public final class Files {
 
-  /** This creates temporary files when Play needs to keep overflow data on the filesystem. */
   public interface TemporaryFileCreator {
     TemporaryFile create(String prefix, String suffix);
 
     TemporaryFile create(Path path);
 
     boolean delete(TemporaryFile temporaryFile);
-
-    // Needed for RawBuffer compatibility
   }
 
-  /** A temporary file created by a TemporaryFileCreator. */
   public interface TemporaryFile {
 
-    /** @return the path to the temporary file. */
     Path path();
 
-    /**
-     * @return the temporaryFile as a java.io.File.
-     * @deprecated Use path() over file().
-     */
     @Deprecated
     File file();
 
     TemporaryFileCreator temporaryFileCreator();
 
     default TemporaryFile moveTo(File to) {
+      return null;
     }
 
     TemporaryFile moveTo(File to, boolean replace);
 
     TemporaryFile atomicMoveWithFallback(File to);
   }
 
-  /** A temporary file creator that delegates to a Scala TemporaryFileCreator. */
   public static class DelegateTemporaryFileCreator implements TemporaryFileCreator {
-    //private final play.api.libs.Files.TemporaryFileCreator temporaryFileCreator;
-
-    //@Inject
-/*     public DelegateTemporaryFileCreator(
-        play.api.libs.Files.TemporaryFileCreator temporaryFileCreator) {
-     *///}
 
     public TemporaryFile create(String prefix, String suffix) {
+      return null;
     }
 
     public TemporaryFile create(Path path) {
+      return null;
     }
 
     public boolean delete(TemporaryFile temporaryFile) {
+      return true;
     }
-
-    //public play.api.libs.Files.TemporaryFileCreator asScala() {}
   }
 
-  /** Delegates to the Scala implementation. */
   public static class DelegateTemporaryFile implements TemporaryFile {
 
     public Path path() {
+      return null;
     }
 
     public File file() {
+      return null;
     }
 
     public TemporaryFileCreator temporaryFileCreator() {
+      return null;
     }
 
     public TemporaryFile moveTo(File to, boolean replace) {
+      return null;
     }
 
     public TemporaryFile atomicMoveWithFallback(File to) {
+      return null;
     }
   }
 
-  /**
-   * A temporary file creator that uses the Scala play.api.libs.Files.SingletonTemporaryFileCreator
-   * class behind the scenes.
-   */
   public static class SingletonTemporaryFileCreator implements TemporaryFileCreator {
     public TemporaryFile create(String prefix, String suffix) {
+      return null;
     }
 
     public TemporaryFile create(Path path) {
+      return null;
     }
 
     public boolean delete(TemporaryFile temporaryFile) {
+      return true;
     }
-
   }
 
   private static final TemporaryFileCreator instance = new Files.SingletonTemporaryFileCreator();
 
-  /** @return the singleton instance of SingletonTemporaryFileCreator. */
   public static TemporaryFileCreator singletonTemporaryFileCreator() {
+    return null;
   }
-}
+}
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/libs/XML.java b/java/ql/test/stubs/playframework-2.6.x/play/libs/XML.java
@@ -1,6 +1,3 @@
 package play.libs;
 
-/** XML utilities. */
-public class XML {
-
-}
+public class XML {}
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/libs/typedmap/TypedKey.java b/java/ql/test/stubs/playframework-2.6.x/play/libs/typedmap/TypedKey.java
@@ -4,13 +4,4 @@
 
 package play.libs.typedmap;
 
-//import play.api.libs.typedmap.TypedKey$;
-
-/**
- * A TypedKey is a key that can be used to get and set values in a {@link TypedMap} or any object
- * with typed keys. This class uses reference equality for comparisons, so each new instance is
- * different key.
- */
-public final class TypedKey<A> {
-
-}
+public final class TypedKey<A> {}
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/libs/typedmap/TypedMap.java b/java/ql/test/stubs/playframework-2.6.x/play/libs/typedmap/TypedMap.java
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/mvc/BodyParser.java b/java/ql/test/stubs/playframework-2.6.x/play/mvc/BodyParser.java
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/mvc/Call.java b/java/ql/test/stubs/playframework-2.6.x/play/mvc/Call.java
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/mvc/Controller.java b/java/ql/test/stubs/playframework-2.6.x/play/mvc/Controller.java
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/mvc/Http.java b/java/ql/test/stubs/playframework-2.6.x/play/mvc/Http.java
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/mvc/Result.java b/java/ql/test/stubs/playframework-2.6.x/play/mvc/Result.java
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/mvc/Results.java b/java/ql/test/stubs/playframework-2.6.x/play/mvc/Results.java
diff --git a/java/ql/test/stubs/playframework-2.6.x/play/twirl/api/Content.java b/java/ql/test/stubs/playframework-2.6.x/play/twirl/api/Content.java
