001    /*
002     *  Licensed to the Apache Software Foundation (ASF) under one
003     *  or more contributor license agreements.  See the NOTICE file
004     *  distributed with this work for additional information
005     *  regarding copyright ownership.  The ASF licenses this file
006     *  to you under the Apache License, Version 2.0 (the
007     *  "License"); you may not use this file except in compliance
008     *  with the License.  You may obtain a copy of the License at
009     *
010     *        http://www.apache.org/licenses/LICENSE-2.0
011     *
012     *  Unless required by applicable law or agreed to in writing,
013     *  software distributed under the License is distributed on an
014     *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     *  KIND, either express or implied.  See the License for the
016     *  specific language governing permissions and limitations
017     *  under the License.
018     */
019    
020    package org.apache.isis.core.progmodel.facets.value.chars;
021    
022    import java.text.DecimalFormat;
023    
024    import org.apache.isis.applib.profiles.Localization;
025    import org.apache.isis.core.commons.config.IsisConfiguration;
026    import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
027    import org.apache.isis.core.metamodel.facetapi.Facet;
028    import org.apache.isis.core.metamodel.facetapi.FacetHolder;
029    import org.apache.isis.core.metamodel.facets.object.parseable.InvalidEntryException;
030    import org.apache.isis.core.progmodel.facets.object.value.ValueSemanticsProviderAndFacetAbstract;
031    import org.apache.isis.core.progmodel.facets.object.value.ValueSemanticsProviderContext;
032    
033    public abstract class CharValueSemanticsProviderAbstract extends ValueSemanticsProviderAndFacetAbstract<Character>
034        implements CharValueFacet {
035    
036        private static Class<? extends Facet> type() {
037            return CharValueFacet.class;
038        }
039    
040        private static final Character DEFAULT_VALUE = Character.valueOf((char) 0);
041        private static final boolean IMMUTABLE = true;
042        private static final boolean EQUAL_BY_CONTENT = true;
043        private static final int TYPICAL_LENGTH = 1;
044    
045        public CharValueSemanticsProviderAbstract(final FacetHolder holder, final Class<Character> adaptedClass,
046            final IsisConfiguration configuration, final ValueSemanticsProviderContext context) {
047            super(type(), holder, adaptedClass, TYPICAL_LENGTH, IMMUTABLE, EQUAL_BY_CONTENT, DEFAULT_VALUE, configuration,
048                context);
049        }
050    
051        // //////////////////////////////////////////////////////////////////
052        // Parser
053        // //////////////////////////////////////////////////////////////////
054    
055        @Override
056        public Character doParse(final Object context, final String entry) {
057            if (entry.length() > 1) {
058                throw new InvalidEntryException("Only a single character is required");
059            } else {
060                return Character.valueOf(entry.charAt(0));
061            }
062        }
063    
064        @Override
065        public String titleString(final Object value, final Localization localization) {
066            return value == null ? "" : value.toString();
067        }
068    
069        @Override
070        public String titleStringWithMask(final Object value, final String usingMask) {
071            return titleString(new DecimalFormat(usingMask), value);
072        }
073    
074        // //////////////////////////////////////////////////////////////////
075        // EncoderDecoder
076        // //////////////////////////////////////////////////////////////////
077    
078        @Override
079        protected String doEncode(final Object object) {
080            return object.toString();
081        }
082    
083        @Override
084        protected Character doRestore(final String data) {
085            return Character.valueOf(data.charAt(0));
086        }
087    
088        // //////////////////////////////////////////////////////////////////
089        // CharValueFacet
090        // //////////////////////////////////////////////////////////////////
091    
092        @Override
093        public Character charValue(final ObjectAdapter object) {
094            return object == null ? null : (Character) object.getObject();
095        }
096    
097        @Override
098        public ObjectAdapter createValue(final Character value) {
099            return getAdapterMap().adapterFor(value);
100        }
101    
102        // /////// toString ///////
103    
104        @Override
105        public String toString() {
106            return "CharacterValueSemanticsProvider";
107        }
108    
109    }