001/**
002 * Copyright 2011-2015 John Ericksen
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *    http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.parceler;
017
018/**
019 * Defines a concrete serialization of an instance to and from a Parcel.
020 *
021 * @author John Ericksen
022 */
023public interface ParcelConverter<T> extends TypeRangeParcelConverter<T, T> {
024
025    String CONVERT_TO_PARCEL = "toParcel";
026    String CONVERT_FROM_PARCEL = "fromParcel";
027
028    /**
029     * Noop ParcelConverter used as a empty placeholder for the Parcel.value annotation parameter.  Performs no mapping
030     * and throws `ParcelerRuntimeExceptions` upon calling any method.
031     */
032    class EmptyConverter implements ParcelConverter<Object> {
033        @Override
034        public void toParcel(Object input, android.os.Parcel destinationParcel) {
035            throw new ParcelerRuntimeException("Empty Converter should not be used.");
036        }
037
038        @Override
039        public Object fromParcel(android.os.Parcel parcel) {
040            throw new ParcelerRuntimeException("Empty Converter should not be used.");
041        }
042    }
043}