-
Notifications
You must be signed in to change notification settings - Fork 2
/
InstanceVisitor.java
74 lines (66 loc) · 2.44 KB
/
InstanceVisitor.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
/**
* Copyright (C) 2017 Czech Technical University in Prague
*
* This program 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 cz.cvut.kbss.jsonld.serialization.traversal;
import java.lang.reflect.Field;
import java.util.Collection;
/**
* Visitor for the object graph traversal.
*/
public interface InstanceVisitor {
/**
* Called when a new instance is discovered by the object graph traverser.
* <p>
* The instances attributes will be processed immediately after this method returns.
*
* @param instance The visited instance
*/
void openInstance(Object instance);
/**
* Called when the graph traverser is done with traversing the specified instance.
*
* @param instance The visited instance
* @see #openInstance(Object)
*/
void closeInstance(Object instance);
/**
* Called when an already known instance is encountered again by the object graph traverser.
*
* @param id Identifier of the instance
* @param instance The instance
*/
void visitKnownInstance(String id, Object instance);
/**
* Called when the object graph traverser discovers a JSON-LD-serializable field in an instance.
*
* @param field The visited field
* @param value Value of the visited field
*/
void visitField(Field field, Object value);
/**
* Called when a collection is encountered by the object traverser.
* <p>
* This can be either when a top-level collection is discovered, or when an object's attribute is a collection.
*
* @param collection The visited collection
*/
void openCollection(Collection<?> collection);
/**
* Called after the last collection item is processed.
*
* @param collection The visited collection
* @see #openCollection(Collection)
*/
void closeCollection(Collection<?> collection);
}