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.httppart;
018
019import static org.apache.juneau.commons.utils.AssertionUtils.*;
020
021import org.apache.juneau.*;
022import org.apache.juneau.serializer.*;
023
024/**
025 * Base class for implementations of {@link HttpPartSerializer}
026 *
027 * <h5 class='section'>Notes:</h5><ul>
028 *    <li class='note'>This class is thread safe and reusable.
029 * </ul>
030 *
031 * <h5 class='section'>See Also:</h5><ul>
032 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/HttpPartSerializersParsers">HTTP Part Serializers and Parsers</a>
033 * </ul>
034 */
035public abstract class BaseHttpPartSerializer extends BeanContextable implements HttpPartSerializer {
036
037   /**
038    * Builder class.
039    */
040   public abstract static class Builder extends BeanContextable.Builder {
041
042      /**
043       * Constructor.
044       */
045      protected Builder() {}
046
047      /**
048       * Copy constructor.
049       * @param builder The existing builder to copy.
050       *    <br>Cannot be <jk>null</jk>.
051       */
052      protected Builder(Builder builder) {
053         super(assertArgNotNull("builder", builder));
054      }
055   }
056
057   /**
058    * Constructor.
059    *
060    * @param builder The builder for this object.
061    */
062   protected BaseHttpPartSerializer(Builder builder) {
063      super(builder);
064   }
065
066   /**
067    * Converts the specified value to a string that can be used as an HTTP header value, query parameter value,
068    * form-data parameter, or URI path variable.
069    *
070    * <p>
071    * Returned values should NOT be URL-encoded.
072    *
073    * @param partType The category of value being serialized.
074    *    <br>Can be <jk>null</jk> (will default to {@link HttpPartType#OTHER}).
075    * @param schema
076    *    Schema information about the part.
077    *    <br>Can be <jk>null</jk>.
078    *    <br>Not all part serializers use the schema information.
079    * @param value The value being serialized.
080    *    <br>Can be <jk>null</jk> (will return <jk>null</jk>).
081    * @return The serialized value.
082    * @throws SerializeException If a problem occurred while trying to parse the input.
083    * @throws SchemaValidationException If the output fails schema validation.
084    */
085   public String serialize(HttpPartType partType, HttpPartSchema schema, Object value) throws SchemaValidationException, SerializeException {
086      return getPartSession().serialize(partType, schema, value);
087   }
088}