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.annotation.*;
017import org.apache.juneau.swap.*;
018
019/**
020 * Built-in object swap implementation class for the {@link Beanp#format() @Beanp(format)} annotation.
021 *
022 * <h5 class='section'>See Also:</h5><ul>
023 *    <li class='link'><a class="doclink" href="../../../../index.html#jm.Swaps">Swaps</a>
024 * </ul>
025 */
026public class StringFormatSwap extends StringSwap<Object> {
027
028   private final String format;
029
030   /**
031    * Constructor.
032    *
033    * @param format The string format string.
034    */
035   public StringFormatSwap(String format) {
036      this.format = format;
037   }
038
039   @Override /* ObjectSwap */
040   public String swap(BeanSession session, Object o) throws Exception {
041      return String.format(format, o);
042   }
043
044   @Override /* ObjectSwap */
045   public Object unswap(BeanSession session, String f, ClassMeta<?> hint) throws Exception {
046      return session.convertToType(f, hint);
047   }
048}