/
ValidatorFamily.java
102 lines (86 loc) · 2.79 KB
/
ValidatorFamily.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
/*
* Copyright 2018 OmniFaces
*
* 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.omnifaces.component.validator;
import java.io.IOException;
import javax.faces.application.Application;
import javax.faces.component.UIComponentBase;
import javax.faces.context.FacesContext;
import javax.faces.event.PostValidateEvent;
import javax.faces.event.PreValidateEvent;
/**
* Base class which is to be shared between all components of the Validator family.
*
* @author Bauke Scholtz
*/
public abstract class ValidatorFamily extends UIComponentBase {
// Public constants -----------------------------------------------------------------------------------------------
/** The standard component family. */
public static final String COMPONENT_FAMILY = "org.omnifaces.component.validator";
// UIComponent overrides ------------------------------------------------------------------------------------------
/**
* Returns {@link #COMPONENT_FAMILY}.
*/
@Override
public String getFamily() {
return COMPONENT_FAMILY;
}
/**
* Returns <code>true</code>.
*/
@Override
public boolean getRendersChildren() {
return true;
}
/**
* Calls {@link #validateHierarchy()}.
*/
@Override
public void processDecodes(FacesContext context) {
validateHierarchy();
}
/**
* Calls {@link #validateComponents(FacesContext)}.
*/
@Override
public void processValidators(FacesContext context) {
Application application = context.getApplication();
application.publishEvent(context, PreValidateEvent.class, this);
validateComponents(context);
application.publishEvent(context, PostValidateEvent.class, this);
}
/**
* Does nothing.
*/
@Override
public void processUpdates(FacesContext context) {
// NOOP.
}
/**
* Calls {@link #validateHierarchy()}.
*/
@Override
public void encodeChildren(FacesContext context) throws IOException {
validateHierarchy();
}
// Actions --------------------------------------------------------------------------------------------------------
/**
* Validate our own component hierarchy.
* @throws IllegalStateException When component hierarchy is wrong.
*/
protected abstract void validateHierarchy();
/**
* Perform the actual validation.
* @param context The faces context to work with.
*/
protected abstract void validateComponents(FacesContext context);
}