blob: 2d67bedf6cef96b8c05af0798d26ae1c6adefb6c (
plain)
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
|
// Copyright 2017 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.devtools.build.lib.skyframe.serialization.autocodec;
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
/**
* Specifies that AutoCodec should generate a codec implementation for the annotated class.
*
* <p>Example:
*
* <pre>{@code
* @AutoCodec
* class Target {
* public static final ObjectCodec<Target> CODEC = new Target_AutoCodec();
* }
* }</pre>
*
* The {@code _AutoCodec} suffix is added to the {@code Target} to obtain the generated class name.
*/
@Target(ElementType.TYPE)
public @interface AutoCodec {
/**
* AutoCodec recursively derives a codec using the public interfaces of the class.
*
* <p>Specific strategies are described below.
*/
public static enum Strategy {
/**
* Uses a constructor of the class to synthesize a codec.
*
* <p>This strategy depends on
*
* <ul>
* <li>a designated constructor to inspect to generate the codec
* <li>the parameters must match member fields on name and type.
* </ul>
*
* <p>If there is a unique constructor, that is the designated constructor, otherwise one must
* be selected using the {@link AutoCodec.Constructor} annotation.
*/
CONSTRUCTOR,
/**
* Uses the public fields to infer serialization code.
*
* <p>Serializes each public field. Calls the no-arg constructor of the class to instantiate an
* instance for deserialization.
*/
PUBLIC_FIELDS,
/**
* For use with abstract classes (enforced at compile time).
*
* <p>Uses reflection to determine the concrete subclass, stores the name of the subclass and
* uses its codec to serialize the data.
*/
POLYMORPHIC,
}
/**
* Marks a specific constructor when using the CONSTRUCTOR strategy.
*
* <p>Indicates a constructor for codec generation. A compile-time error will result if multiple
* constructors are thus tagged.
*/
@Target(ElementType.CONSTRUCTOR)
public static @interface Constructor {}
Strategy strategy() default Strategy.CONSTRUCTOR;
}
|
