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 static org.apache.juneau.common.internal.StringUtils.*;
016
017import org.apache.juneau.*;
018import org.apache.juneau.swap.*;
019
020/**
021 * Transforms <code><jk>byte</jk>[]</code> arrays to Strings.
022 *
023 * <h5 class='section'>See Also:</h5><ul>
024 *    <li class='link'><a class="doclink" href="../../../../index.html#jm.Swaps">Swaps</a>
025
026 * </ul>
027 */
028public abstract class ByteArraySwap extends StringSwap<byte[]> {
029
030   /**
031    * Converts byte arrays to BASE-64 encoding.
032    */
033   public static class Base64 extends ByteArraySwap {
034      /**
035       * Converts the specified <code><jk>byte</jk>[]</code> to a {@link String}.
036       */
037      @Override /* ObjectSwap */
038      public String swap(BeanSession session, byte[] b) throws Exception {
039         return base64Encode(b);
040      }
041
042      /**
043       * Converts the specified {@link String} to a <code><jk>byte</jk>[]</code>.
044       */
045      @Override /* ObjectSwap */
046      public byte[] unswap(BeanSession session, String s, ClassMeta<?> hint) throws Exception {
047         return base64Decode(s);
048      }
049   }
050
051   /**
052    * Converts byte arrays to hex encoding.
053    */
054   public static class Hex extends ByteArraySwap {
055      /**
056       * Converts the specified <code><jk>byte</jk>[]</code> to a {@link String}.
057       */
058      @Override /* ObjectSwap */
059      public String swap(BeanSession session, byte[] b) throws Exception {
060         return toHex(b);
061      }
062
063      /**
064       * Converts the specified {@link String} to a <code><jk>byte</jk>[]</code>.
065       */
066      @Override /* ObjectSwap */
067      public byte[] unswap(BeanSession session, String s, ClassMeta<?> hint) throws Exception {
068         return fromHex(s);
069      }
070   }
071
072   /**
073    * Converts byte arrays to spaced-hex encoding.
074    */
075   public static class SpacedHex extends ByteArraySwap {
076      /**
077       * Converts the specified <code><jk>byte</jk>[]</code> to a {@link String}.
078       */
079      @Override /* ObjectSwap */
080      public String swap(BeanSession session, byte[] b) throws Exception {
081         return toSpacedHex(b);
082      }
083
084      /**
085       * Converts the specified {@link String} to a <code><jk>byte</jk>[]</code>.
086       */
087      @Override /* ObjectSwap */
088      public byte[] unswap(BeanSession session, String s, ClassMeta<?> hint) throws Exception {
089         return fromSpacedHex(s);
090      }
091   }
092}