/
MyBatisContext.java
110 lines (96 loc) · 2.91 KB
/
MyBatisContext.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
98
99
100
101
102
103
104
105
106
107
108
109
110
/*
* Copyright 2017-2020 the original author or authors.
*
* 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
*
* https://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 org.springframework.data.jdbc.mybatis;
import java.util.Collections;
import java.util.Map;
import org.springframework.data.relational.domain.Identifier;
import org.springframework.lang.Nullable;
/**
* {@link MyBatisContext} instances get passed to MyBatis mapped statements as arguments, making Ids, instances,
* domainType and other attributes available to the statements. All methods might return {@literal null} depending on
* the kind of values available on invocation.
*
* @author Jens Schauder
* @author Christoph Strobl
*/
public class MyBatisContext {
private final @Nullable Object id;
private final @Nullable Object instance;
private final @Nullable Identifier identifier;
private final @Nullable Class domainType;
private final Map<String, Object> additonalValues;
public MyBatisContext(@Nullable Object id, @Nullable Object instance, @Nullable Class domainType,
Map<String, Object> additonalValues) {
this.id = id;
this.identifier = null;
this.instance = instance;
this.domainType = domainType;
this.additonalValues = additonalValues;
}
public MyBatisContext(Identifier identifier, @Nullable Object instance, @Nullable Class<?> domainType) {
this.id = null;
this.identifier = identifier;
this.instance = instance;
this.domainType = domainType;
this.additonalValues = Collections.emptyMap();
}
/**
* The ID of the entity to query/act upon.
*
* @return Might return {@code null}.
*/
@Nullable
public Object getId() {
return id;
}
/**
* The {@link Identifier} for a path to query.
*
* @return Might return {@literal null}.
*/
@Nullable
public Identifier getIdentifier() {
return identifier;
}
/**
* The entity to act upon. This is {@code null} for queries, since the object doesn't exist before the query.
*
* @return Might return {@code null}.
*/
@Nullable
public Object getInstance() {
return instance;
}
/**
* The domain type of the entity to query or act upon.
*
* @return Might return {@code null}.
*/
@Nullable
public Class getDomainType() {
return domainType;
}
/**
* Returns a value for the given key. Used to communicate ids of parent entities.
*
* @param key Must not be {@code null}.
* @return Might return {@code null}.
*/
@Nullable
public Object get(String key) {
return additonalValues.get(key);
}
}