Skip to content

Commit b326fdb

Browse files
Add @IdCompanion annotation.
1 parent f2aadab commit b326fdb

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
/*
2+
* Copyright 2021 ObjectBox Ltd. All rights reserved.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package io.objectbox.annotation;
18+
19+
import java.lang.annotation.ElementType;
20+
import java.lang.annotation.Retention;
21+
import java.lang.annotation.RetentionPolicy;
22+
import java.lang.annotation.Target;
23+
24+
/**
25+
* Marks a property as a companion to an @Id property. There can only be one companion property.
26+
* <p>
27+
* By defining an @Id companion property, the entity type uses a special ID encoding scheme involving this property
28+
* in addition to the ID.
29+
* <p>
30+
* For Time Series IDs, a companion property of type Date or DateNano represents the exact timestamp.
31+
*/
32+
@Retention(RetentionPolicy.CLASS)
33+
@Target(ElementType.FIELD)
34+
public @interface IdCompanion {
35+
}

0 commit comments

Comments
 (0)