001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.swaps;
018
019import org.apache.juneau.*;
020import org.apache.juneau.annotation.*;
021import org.apache.juneau.swap.*;
022
023/**
024 * Built-in object swap implementation class for the {@link Beanp#format() @Beanp(format)} annotation.
025 *
026 * <h5 class='section'>See Also:</h5><ul>
027 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/SwapBasics">Swap Basics</a>
028 * </ul>
029 */
030public class StringFormatSwap extends StringSwap<Object> {
031
032   private final String format;
033
034   /**
035    * Constructor.
036    *
037    * @param format The string format string.
038    */
039   public StringFormatSwap(String format) {
040      this.format = format;
041   }
042
043   @Override /* ObjectSwap */
044   public String swap(BeanSession session, Object o) throws Exception {
045      return String.format(format, o);
046   }
047
048   @Override /* ObjectSwap */
049   public Object unswap(BeanSession session, String f, ClassMeta<?> hint) throws Exception {
050      return session.convertToType(f, hint);
051   }
052}