Skip to content

Commit 3d9c6e6

Browse files
committed
Property: minor java docs improvements
1 parent 3f2d2b3 commit 3d9c6e6

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

objectbox-java/src/main/java/io/objectbox/Property.java

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2017 ObjectBox Ltd. All rights reserved.
2+
* Copyright 2017-2019 ObjectBox Ltd. All rights reserved.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -29,7 +29,8 @@
2929
import io.objectbox.query.QueryCondition.PropertyCondition.Operation;
3030

3131
/**
32-
* Meta data describing a property
32+
* Meta data describing a property of an ObjectBox entity.
33+
* Properties are typically used to define query criteria using {@link io.objectbox.query.QueryBuilder}.
3334
*/
3435
@SuppressWarnings("WeakerAccess,UnusedReturnValue, unused")
3536
public class Property<ENTITY> implements Serializable {
@@ -89,48 +90,48 @@ public Property(EntityInfo<ENTITY> entity, int ordinal, int id, Class<?> type, S
8990
this.customType = customType;
9091
}
9192

92-
/** Creates an "equal ('=')" condition for this property. */
93+
/** Creates an "equal ('=')" condition for this property. */
9394
public QueryCondition eq(Object value) {
9495
return new PropertyCondition(this, Operation.EQUALS, value);
9596
}
9697

97-
/** Creates an "not equal ('&lt;&gt;')" condition for this property. */
98+
/** Creates an "not equal ('&lt;&gt;')" condition for this property. */
9899
public QueryCondition notEq(Object value) {
99100
return new PropertyCondition(this, Operation.NOT_EQUALS, value);
100101
}
101102

102-
/** Creates an "BETWEEN ... AND ..." condition for this property. */
103+
/** Creates an "BETWEEN ... AND ..." condition for this property. */
103104
public QueryCondition between(Object value1, Object value2) {
104105
Object[] values = {value1, value2};
105106
return new PropertyCondition(this, Operation.BETWEEN, values);
106107
}
107108

108-
/** Creates an "IN (..., ..., ...)" condition for this property. */
109+
/** Creates an "IN (..., ..., ...)" condition for this property. */
109110
public QueryCondition in(Object... inValues) {
110111
return new PropertyCondition(this, Operation.IN, inValues);
111112
}
112113

113-
/** Creates an "IN (..., ..., ...)" condition for this property. */
114+
/** Creates an "IN (..., ..., ...)" condition for this property. */
114115
public QueryCondition in(Collection<?> inValues) {
115116
return in(inValues.toArray());
116117
}
117118

118-
/** Creates an "greater than ('&gt;')" condition for this property. */
119+
/** Creates an "greater than ('&gt;')" condition for this property. */
119120
public QueryCondition gt(Object value) {
120121
return new PropertyCondition(this, Operation.GREATER_THAN, value);
121122
}
122123

123-
/** Creates an "less than ('&lt;')" condition for this property. */
124+
/** Creates an "less than ('&lt;')" condition for this property. */
124125
public QueryCondition lt(Object value) {
125126
return new PropertyCondition(this, Operation.LESS_THAN, value);
126127
}
127128

128-
/** Creates an "IS NULL" condition for this property. */
129+
/** Creates an "IS NULL" condition for this property. */
129130
public QueryCondition isNull() {
130131
return new PropertyCondition(this, Operation.IS_NULL, null);
131132
}
132133

133-
/** Creates an "IS NOT NULL" condition for this property. */
134+
/** Creates an "IS NOT NULL" condition for this property. */
134135
public QueryCondition isNotNull() {
135136
return new PropertyCondition(this, Operation.IS_NOT_NULL, null);
136137
}

0 commit comments

Comments
 (0)