src/main/java/com/amazon/carbonado/Indexes.java


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

/*
 * Copyright 2006 Amazon Technologies, Inc. or its affiliates.
 * Amazon, Amazon.com and Carbonado are trademarks or registered trademarks
 * of Amazon Technologies, Inc. or its affiliates.  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.amazon.carbonado;

import java.lang.annotation.*;

/**
 * The Indexes annotation is applied to a {@link Storable} for specifying all
 * the {@link Index indexes} it should have.
 *
 * <p>Example:<pre>
 * <b>&#64;Indexes</b>({
 *     <b>&#64;Index</b>("name"),
 *     <b>&#64;Index</b>("-lastModified"),
 *     <b>&#64;Index</b>({"length", "lastModified"})
 * })
 * &#64;PrimaryKey("ID")
 * public interface FileInfo extends Storable&lt;FileInfo&gt; {
 *     long getID();
 *     void setID(long id);
 *
 *     String getName();
 *     void setName(String name);
 *
 *     long getLength();
 *     void setLength(long length);
 *
 *     long getLastModified();
 *     void getLastModified(long datetime);
 *
 *     ...
 * }
 * </pre>
 *
 * @author Brian S O'Neill
 * @see Index
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface Indexes {
    /**
     * A list of Index annotations.
     */
    Index[] value() default {};
}