Lines Matching +full:java +full:- +full:docs +full:- +full:samples

3 Currently, the main purpose of these samples is to act as a source of test cases
17 write such samples if we were starting from scratch today, but we wrote them
25 Whatever our final samples look like, we do **not** expect to present them as
28 -   JSpecify nullness information may be of use to many kinds of tools, not just
29     "nullness checkers." But these samples are written in a way that makes them
30     most useful to authors of nullness checkers. Authors of other tools -- those
32     etc. -- are not best served by the samples' focus on
35 -   The goal of JSpecify is to provide one source of nullness information. Tools
39     -   Some examples of "information from other sources":
41         -   looking at the *implementation* of a method to decide whether it can
43         -   looking at non-JSpecify nullness annotations in code
44         -   looking at "overlay" or "stub" information about nullness for
45             well-known APIs
46         -   looking at whether the parameter to a call to `Map.get` is known to
48         -   defining a rule to treat all unannotated type usages the same, when
51 -   Based on the information they have available for any given piece of code,
60 <!-- TODO: Update links to point to the markup-format spec and glossary. -->
62 A special comment on a given line of a `.java` file provides information about
67 [unrecognized](http://jspecify.org/spec#recognized-locations-type-use). Tools
73 -   `jspecify_conflicting_annotations`: for cases like `@Nullable
76 -   `jspecify_nullness_intrinsically_not_nullable`: for cases like `@Nullable
79 -   `jspecify_unrecognized_location`: for the other cases in which JSpecify does
96 -   `jspecify_nullness_mismatch`
98 -   `jspecify_nullness_not_enough_information`: for nullness violations that
100 …[unspecified nullness](https://docs.google.com/document/d/1KQrBxwaVIPIac_6SCf--w-vZBeHkTvtaqPSU_ic…
104 -   multiline comments
105 -   other locations for comments
106 -   multiple findings per line/comment
107 -   comments that apply to larger ranges -- possibly to syntax elements (like
109 -   comments that apply only to a particular part of the line
114 [JSpecify: test-data format: Directory structure](https://docs.google.com/document/d/1JVH2p61kReO8b…
123 TODO: Consider requiring that all individual-file samples be in the top-level
126 Each file must contain a single top-level class. TODO(#133): Consider relaxing
131 -   individual-file samples: `Foo.java` for `Foo`
133 -   full-directory samples: `sampleFoo/Foo.java` for `Foo`,
134     `sampleFoo/bar/Foo.java` for `bar.Foo`
136 -   We may need additional accommodations for JPMS support to demonstrate
137     module-level defaulting.
141 Files must be UTF-8 encoded.
145 Files must be compatible with Java 8. TODO(#131): Decide how to label files that
147 sticking to Java 8 except for tests that specifically exercise newer features.)
152 includes the Java platform APIs. Exception: Files may use `java.lang.Object`,
160 -   looking inside the body of a method to determine what parameters it
163     -   To that end, prefer abstract methods when practical.
165 -   flow-sensitive typing
169 rely on type inference -- except, of course, for any files explicitly intended
174 TODO: Consider how to map between samples and related GitHub issues (comments,