org.apache.juneau.marshall.UrlEncoding 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.marshall;
import org.apache.juneau.urlencoding.*;
/**
* A pairing of a {@link UrlEncodingSerializer} and {@link UrlEncodingParser} into a single class with convenience read/write methods.
*
*
* The general idea is to combine a single serializer and parser inside a simplified API for reading and writing POJOs.
*
*
Examples:
*
* // Using instance.
* UrlEncoding urlEncoding = new UrlEncoding();
* MyPojo myPojo = urlEncoding.read(string, MyPojo.class );
* String string = urlEncoding.write(myPojo);
*
*
* // Using DEFAULT instance.
* MyPojo myPojo = UrlEncoding.DEFAULT .read(string, MyPojo.class );
* String string = UrlEncoding.DEFAULT .write(myPojo);
*
*
* See Also:
*
* - {@doc juneau-marshall.Marshalls}
*
*/
public class UrlEncoding extends CharMarshall {
/**
* Default reusable instance.
*/
public static final UrlEncoding DEFAULT = new UrlEncoding();
/**
* Constructor.
*
* @param s
* The serializer to use for serializing output.
*
Must not be null .
* @param p
* The parser to use for parsing input.
*
Must not be null .
*/
public UrlEncoding(UrlEncodingSerializer s, UrlEncodingParser p) {
super(s, p);
}
/**
* Constructor.
*
*
* Uses {@link UrlEncodingSerializer#DEFAULT} and {@link UrlEncodingParser#DEFAULT}.
*/
public UrlEncoding() {
this(UrlEncodingSerializer.DEFAULT, UrlEncodingParser.DEFAULT);
}
}