org.apache.juneau.transform.StringSwap Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *
// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *
// * with the License. You may obtain a copy of the License at *
// * *
// * http://www.apache.org/licenses/LICENSE-2.0 *
// * *
// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
package org.apache.juneau.transform;
import org.apache.juneau.*;
/**
* Abstract subclass for POJO swaps that swap objects for strings.
*
* Example:
*
* // A swap that converts byte arrays to BASE64-encoded strings.
* public class ByteArrayBase64Swap extends StringSwap<byte []> {
*
* @Override
* public String swap(BeanSession session, byte [] b) throws Exception {
* return StringUtils.base64Encode (b);
* }
*
* @Override
* public byte [] unswap(BeanSession session, String s, ClassMeta<?> hint) throws Exception {
* return StringUtils.base64Decode (s);
* }
* }
*
* // Use it to serialize a byte array.
* WriterSerializer s = JsonSerializer.create ().simple().pojoSwaps(ByteArrayBase64Swap.class ).build();
* String json = s.serialize(new byte [] {1,2,3}); // Produces "'AQID'"
*
*
* @param The normal form of the class.
*/
public abstract class StringSwap extends PojoSwap {
@Override /* PojoSwap */
public String swap(BeanSession session, T o) throws Exception {
return super.swap(session, o);
}
@Override /* PojoSwap */
public T unswap(BeanSession session, String f, ClassMeta hint) throws Exception {
return super.unswap(session, f, hint);
}
}