-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
IdValidator.java
97 lines (91 loc) · 3.04 KB
/
IdValidator.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
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
/*
* Copyright (c) 2002-2017 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.kernel.impl.store.id.validation;
import org.neo4j.kernel.impl.store.id.IdGenerator;
import org.neo4j.kernel.impl.store.id.IdGeneratorImpl;
import org.neo4j.kernel.impl.store.record.AbstractBaseRecord;
/**
* Utility containing methods to validate record id used in {@link AbstractBaseRecord} and possibly generated by
* {@link IdGenerator}. Takes into account special reserved value {@link IdGeneratorImpl#INTEGER_MINUS_ONE}.
*/
public final class IdValidator
{
private IdValidator()
{
}
/**
* Checks if the given id is reserved, i.e. {@link IdGeneratorImpl#INTEGER_MINUS_ONE}.
*
* @param id the id to check.
* @return <code>true</code> if the given id is {@link IdGeneratorImpl#INTEGER_MINUS_ONE}, <code>false</code>
* otherwise.
* @see IdGeneratorImpl#INTEGER_MINUS_ONE
*/
public static boolean isReservedId( long id )
{
return id == IdGeneratorImpl.INTEGER_MINUS_ONE;
}
/**
* Asserts that the given id is valid:
* <ul>
* <li>non-negative
* <li>less than the given max id
* <li>not equal to {@link IdGeneratorImpl#INTEGER_MINUS_ONE}
* </ul>
*
* @param id the id to check.
* @param maxId the max allowed id.
* @see IdGeneratorImpl#INTEGER_MINUS_ONE
*/
public static void assertValidId( long id, long maxId )
{
if ( isReservedId( id ) )
{
throw new ReservedIdException( id );
}
assertIdWithinCapacity( id, maxId );
}
/**
* Asserts that the given id is valid with respect to given max id:
* <ul>
* <li>non-negative
* <li>less than the given max id
* </ul>
*
* @param id the id to check.
* @param maxId the max allowed id.
*/
public static void assertIdWithinCapacity( long id, long maxId )
{
if ( id < 0 )
{
throw new NegativeIdException( id );
}
if ( id > maxId )
{
throw new IdCapacityExceededException( id, maxId );
}
}
public static boolean hasReservedIdInRange( long startIdInclusive, long endIdExclusive )
{
return startIdInclusive <= IdGeneratorImpl.INTEGER_MINUS_ONE &&
endIdExclusive > IdGeneratorImpl.INTEGER_MINUS_ONE;
}
}