/
PropertyDesc.java
170 lines (149 loc) · 4.93 KB
/
PropertyDesc.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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
/*
* Copyright 2012-2024 CodeLibs Project and the Others.
*
* 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
*
* http://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.codelibs.core.beans;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.Collection;
import java.util.Map;
/**
* プロパティを扱うためのインターフェースです。
*
* @author higa
*/
public interface PropertyDesc {
/**
* プロパティ名を返します。
*
* @return プロパティ名
*/
String getPropertyName();
/**
* プロパティの型を返します。
*
* @param <T>
* プロパティの型
* @return プロパティの型
*/
<T> Class<T> getPropertyType();
/**
* getterメソッドを返します。
*
* @return getterメソッド
*/
Method getReadMethod();
/**
* getterメソッドを持っているかどうか返します。
*
* @return getterメソッドを持っているかどうか
*/
boolean hasReadMethod();
/**
* setterメソッドを返します。
*
* @return setterメソッド
*/
Method getWriteMethod();
/**
* setterメソッドを持っているかどうか返します。
*
* @return setterメソッドを持っているかどうか
*/
boolean hasWriteMethod();
/**
* プロパティの値が取得できるかどうかを返します。
*
* @return プロパティの値が取得できるかどうか
*/
boolean isReadable();
/**
* プロパティの値が設定できるかどうかを返します。
*
* @return プロパティの値が設定できるかどうか
*/
boolean isWritable();
/**
* プロパティとして認識しているpublicフィールドを返します。
*
* @return プロパティとして認識するpublicフィールド
*/
Field getField();
/**
* プロパティの値を返します。
*
* @param <T>
* プロパティの型
* @param target
* ターゲットオブジェクト。{@literal null}であってはいけません
* @return プロパティの値
*/
<T> T getValue(Object target);
/**
* プロパティに値を設定します。
*
* @param target
* ターゲットオブジェクト。{@literal null}であってはいけません
* @param value
* プロパティに設定する値
*/
void setValue(Object target, Object value);
/**
* プロパティの型に応じて必要なら適切に変換します。
*
* @param <T>
* 変換された型
* @param value
* 値
* @return 変換された値
*/
<T> T convertIfNeed(Object value);
/**
* {@link BeanDesc}を返します。
*
* @return {@link BeanDesc}
*/
BeanDesc getBeanDesc();
/**
* このプロパティがパラメタ化された型の場合は{@literal true}を返します。
*
* @return このプロパティがパラメタ化された型の場合は{@literal true}
*/
boolean isParameterized();
/**
* このプロパティがパラメタ化された型の場合、その情報を返します。
*
* @return このプロパティがパラメタ化された型の場合はその情報、そうでない場合は{@literal null}
*/
ParameterizedClassDesc getParameterizedClassDesc();
/**
* このプロパティがパラメタ化された{@link Collection}の場合、その要素型を返します。
*
* @return このプロパティがパラメタ化された{@link Collection}の場合はその要素型、そうでない場合は
* {@literal null}
*/
Class<?> getElementClassOfCollection();
/**
* このプロパティがパラメタ化された{@link Map}の場合、そのキー型を返します。
*
* @return このプロパティがパラメタ化された{@link Map}の場合はそのキー型、そうでない場合は{@literal null}
*/
Class<?> getKeyClassOfMap();
/**
* このプロパティがパラメタ化された{@link Map}の場合、その値型を返します。
*
* @return このプロパティがパラメタ化された{@link Map}の場合はその値型、そうでない場合は{@literal null}
*/
Class<?> getValueClassOfMap();
}