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