1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153 | package Torello.JavaDoc.Annotations;
import Torello.JavaDoc.Entity;
import java.util.regex.Pattern;
import java.util.function.Predicate;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import java.lang.annotation.Repeatable;
import static java.lang.annotation.RetentionPolicy.SOURCE;
import static java.lang.annotation.ElementType.*;
// EXPORTS:
//
// public String handle();
// public String typeName() default "";
// public Entity entity();
// public String name();
// public byte paramCount() default -1;
// public String[] paramNames() default { };
// public String[] paramTypesJOW() default { };
//
//
// The following files are relatedf to this Annotation-Mirror Data-Class:
//
// package Torello.JDUInternal.Features.LINK_JAVA_SOURCE
// This package does the "vast majority" of the work that is needed process a User's
// Annotation-Placement. The classes in the packages in this class look for, and load, all
// of the External '.java'-Files which have been specified by the programmer's annotation
// uses. These classes also perform the Source-Code HiLiting, and save the output to the
// appropriate packge's '[pkg-javadoc]/ljs-hilite-files/' directory. They finally, also,
// generate the appropriate "HREF=..." so that an appropriate '<A HREF...>' link may be
// inserted
/** <EMBED CLASS='external-html' DATA-FILE-ID=LJS_TOP_EXAMPLE> */
@Retention(SOURCE)
@Target({TYPE, FIELD, CONSTRUCTOR, METHOD})
@Repeatable(Torello.JavaDoc.Annotations.hidden.LJSRepeatable.class)
public @interface LinkJavaSource
{
/**
* The {@code String}-Value which is provided to this element specifies which HiLited
* Source-Code File to use for the URL-Link in this {@code <A HREF>}-Button.
*
* <EMBED CLASS='external-html' DATA-FILE-ID=LJS_HANDLE>
* <EMBED CLASS='external-html' DATA-FILE-ID=LJS_HANDLE_EX>
*/
public String handle();
// The "handle" Annotation-Element is Mandatory, Not Optional. (No Default value
// is provided in the @LinkJavaSource Annotation-Class). It is supposed to contain
// "a pointer" or "File-Name Nick-Name" (a handle!) to a file that has been listed
// inside the File:
// "../upgrade-files/json-config/ExtraJavaHiLiting.json"
//
// Every one of the '.java' Source-Files listed inside that '.json' files must
// contain:
// 1) A Valid '.java' File-Name
// 2) A handle for referencing that File-Name with the @LinkJavaSource
// Annotation
/**
* This {@code String} may be used to specify an '<B>Inner-Type</B>', '<B>Nested-Type</B>' or
* possibly an '<B>Auxilliary-Class</B>'.
*
* <EMBED CLASS='external-html' DATA-FILE-ID=LJS_TYPE_NAME>
* <EMBED CLASS='external-html' DATA-FILE-ID=LJS_TYPE_NAME_EX>
*/
public String typeName() default "";
// It is altogether possible for the User to have requested that '.java' File be
// Hi-Lited which contains a class that actually has one or more inner-types,
// inner-interfaces or even auxiliary classes!
//
// If the user would like the "name()" that he has provided to actually
// reference something other than the primary Class, Interface, Enum or Record,
// (such as an Inner-Type or an Auxiliary-Type), he must provided the exact,
// Full-Package, name of the Class or Type inside that file that he is intending
// to reference.
//
// He may do this by passing a valid Full-Package Java Class or Type-Name to this
// Optional Annotation-Element.
//
// This Annotation-Element is Optional, and has a default value (assigned by the
// 'javac' Annotations-Processor equal to the Empty-String)
/**
* When specifying a Line-Number to use for the link, identifies which kind of {@link Entity}
* is being linked.
*
* <EMBED CLASS='external-html' DATA-FILE-ID=LJS_ENTITY>
* <EMBED CLASS='external-html' DATA-FILE-ID=LJS_ENTITY_EX>
*/
public Entity entity() default Entity.METHOD;
/**
* When specifying a Line-Number to use, identifies the {@link Entity} or "Member" Name.
*
* <EMBED CLASS='external-html' DATA-FILE-ID=LJS_NAME>
* <EMBED CLASS='external-html' DATA-FILE-ID=LJS_NAME_EX>
*/
public String name() default "";
// The "name()" Annotation-Element should contain the name of the Member/Entity
// contained by the Class/Interface/Type (CIET) which is specified by "handle()"
//
// "name()" is allowed to be optional in the case that the user is specifying a
// constructor. If so, he must provide either a paramNames(), a paramTypesJOW or a
// paramCount().
//
// Specifically: "name" should be the name of a Field, Method,
// Constructor (Optional) or Enum-Constant from the CIET/Type named
// by "handle()"
/**
* When specifying the Line-Number of either a {@link Entity#METHOD Method} or a
* {@link Entity#CONSTRUCTOR Constructor}, identifies the number of parameters contained by
* the Method or Constructor Signature.
*
* <EMBED CLASS='external-html' DATA-FILE-ID=LJS_PARAM_COUNT>
* <EMBED CLASS='external-html' DATA-FILE-ID=LJS_PARAM_COUNT_EX>
*/
public byte paramCount() default -1;
/**
* When specifying the Line-Number of either a {@link Entity#METHOD Method} or a
* {@link Entity#CONSTRUCTOR Constructor}, identifies the names of the parameters accepted by
* the Method or Constructor.
*
* <EMBED CLASS='external-html' DATA-FILE-ID=LJS_PARAM_NAMES>
* <EMBED CLASS='external-html' DATA-FILE-ID=LJS_PARAM_NAMES_EX>
*/
public String[] paramNames() default { };
/**
* When specifying the Line-Number of either a {@link Entity#METHOD Method} or a
* {@link Entity#CONSTRUCTOR Constructor}, identifies the Single-Word-Names for the
* <B>{@code 'types'}</B> of the Method's or Constructor's parameters.
*
* <BR /><BR />For example, if a method such as {@code boolean equals(Object other)} were
* needing to be linked, the "Single Word Name" would be
* <B STYLE='color: red;'>{@code String}</B>, rather than {@code 'java.lang.String'}
*
* <EMBED CLASS='external-html' DATA-FILE-ID=LJS_PARAM_TYPES_JOW>
* <EMBED CLASS='external-html' DATA-FILE-ID=LJS_PARAM_T_JOW_EX>
*/
public String[] paramTypesJOW() default { };
}
|