-
Notifications
You must be signed in to change notification settings - Fork 220
/
NamePattern.java
58 lines (55 loc) · 2.05 KB
/
NamePattern.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
/*
* Copyright (c) 2008-2016 Haulmont.
*
* 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 com.haulmont.chile.core.annotations;
import com.haulmont.cuba.core.entity.annotation.MetaAnnotation;
import java.lang.annotation.Target;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
/**
* Defines an instance name format pattern in the form {0}|{1}, where
* <ul>
* <li>{0} - format string as for {@link String#format}, or a name of this object method, returning string,
* with {@code #} symbol in the beginning.</li>
* <li>{1} - comma-separated list of field names, corresponding to format {0}. These fields are also used for
* defining a {@code _minimal} view of this entity.</li>
* </ul>
* Extra spaces between parts are not allowed.
*
* <br> Format string example: {@code @NamePattern("%s : %s|name,address")}
*
* <br> Method example:
* {@code @NamePattern("#getCaption|login,name")}
* <pre>
* public class User extends StandardEntity {
* ...
* public String getCaption() {
* String pattern = AppContext.getProperty("cuba.user.namePattern");
* if (StringUtils.isBlank(pattern)) {
* pattern = "{1} [{0}]";
* }
* MessageFormat fmt = new MessageFormat(pattern);
* return fmt.format(new Object[] {login, name});
* }
* }
* </pre>
*/
@Target({java.lang.annotation.ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@MetaAnnotation
public @interface NamePattern {
String value();
}