1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package javax.faces.convert;
20
21 import javax.faces.component.UIComponent;
22 import javax.faces.context.FacesContext;
23 import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFWebConfigParam;
24
25 /**
26 * see Javadoc of <a href="http://java.sun.com/javaee/javaserverfaces/1.2/docs/api/index.html">JSF Specification</a>
27 */
28 public interface Converter<T>
29 {
30 /**
31 * Set the default timezone as system timezone when a converter extending from DateTimeConverter is created.
32 */
33 @JSFWebConfigParam(defaultValue="false", expectedValues="true, false", since="2.0", group="validation")
34 public static final String DATETIMECONVERTER_DEFAULT_TIMEZONE_IS_SYSTEM_TIMEZONE_PARAM_NAME =
35 "javax.faces.DATETIMECONVERTER_DEFAULT_TIMEZONE_IS_SYSTEM_TIMEZONE";
36
37 T getAsObject(FacesContext context,
38 UIComponent component,
39 String value) throws ConverterException;
40
41 String getAsString(FacesContext context,
42 UIComponent component,
43 T value) throws ConverterException;
44 }