001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.swaps;
014
015import org.apache.juneau.*;
016import org.apache.juneau.swap.*;
017
018/**
019 * Transforms beans into {@link String Strings} by simply calling the {@link Object#toString()} method.
020 *
021 * <p>
022 * Allows you to specify classes that should just be converted to {@code Strings} instead of potentially
023 * being turned into Maps by the {@link BeanContext} (or worse, throwing
024 * {@link BeanRuntimeException BeanRuntimeExceptions}).
025 *
026 * <p>
027 * This is usually a one-way transform.
028 * Beans serialized as strings cannot be reconstituted using a parser unless it is a
029 * <a class="doclink" href="../../../../index.html#jm.PojoCategories">parsable POJO</a>.
030 *
031 * <h5 class='section'>See Also:</h5><ul>
032 *    <li class='link'><a class="doclink" href="../../../../index.html#jm.Swaps">Swaps</a>
033
034 * </ul>
035 *
036 * @param <T> The class type of the bean.
037 */
038public class BeanStringSwap<T> extends StringSwap<T> {
039
040   /**
041    * Converts the specified bean to a {@link String}.
042    */
043   @Override /* ObjectSwap */
044   public String swap(BeanSession session, T o) {
045      return o.toString();
046   }
047}