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.marshall.swaps;
018
019import static org.apache.juneau.commons.utils.Shorts.*;
020
021import org.apache.juneau.marshall.*;
022import org.apache.juneau.marshall.swap.spi.*;
023
024/**
025 * Built-in object swap implementation class for the {@link MarshalledProp#format() @MarshalledProp(format)} annotation.
026 *
027 * <h5 class='section'>See Also:</h5><ul>
028 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/Swaps">Swap</a>
029 * </ul>
030 */
031public class StringFormatSwap extends StringSwap<Object> {
032
033   private final String format;
034
035   /**
036    * Constructor.
037    *
038    * @param format The {@link java.util.Formatter} format string. Must not be <jk>null</jk>.
039    */
040   public StringFormatSwap(String format) {
041      this.format = format;
042   }
043
044   @Override /* Overridden from ObjectSwap */
045   public String swap(MarshallingSession session, Object o) throws Exception {
046      return f(format, o);
047   }
048
049   @Override /* Overridden from ObjectSwap */
050   public Object unswap(MarshallingSession session, String f, ClassMeta<?> hint) throws Exception {
051      return session.convertToType(f, hint);
052   }
053}