All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.juneau.uon.UonParser 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.uon;

import static org.apache.juneau.collections.JsonMap.*;
import java.lang.annotation.*;
import java.lang.reflect.*;
import java.nio.charset.*;
import java.util.*;
import java.util.concurrent.*;

import org.apache.juneau.*;
import org.apache.juneau.collections.*;
import org.apache.juneau.httppart.*;
import org.apache.juneau.internal.*;
import org.apache.juneau.parser.*;
import org.apache.juneau.utils.*;

/**
 * Parses UON (a notation for URL-encoded query parameter values) text into POJO models.
 *
 * 
Media types
*

* Handles Content-Type types: text/uon * *

Description
*

* This parser uses a state machine, which makes it very fast and efficient. * *

Notes:
    *
  • This class is thread safe and reusable. *
* *
See Also:
*/ public class UonParser extends ReaderParser implements HttpPartParser, UonMetaProvider { //------------------------------------------------------------------------------------------------------------------- // Static //------------------------------------------------------------------------------------------------------------------- /** Reusable instance of {@link UonParser}, all default settings. */ public static final UonParser DEFAULT = new UonParser(create()); /** Reusable instance of {@link UonParser} with decodeChars set to true. */ public static final UonParser DEFAULT_DECODING = new UonParser.Decoding(create()); /** * Creates a new builder for this object. * * @return A new builder. */ public static Builder create() { return new Builder(); } //------------------------------------------------------------------------------------------------------------------- // Static subclasses //------------------------------------------------------------------------------------------------------------------- /** Default parser, decoding. */ public static class Decoding extends UonParser { /** * Constructor. * * @param builder The builder for this object. */ public Decoding(Builder builder) { super(builder.decoding()); } } //------------------------------------------------------------------------------------------------------------------- // Builder //------------------------------------------------------------------------------------------------------------------- /** * Builder class. */ @FluentSetters public static class Builder extends ReaderParser.Builder { private static final Cache CACHE = Cache.of(HashKey.class, UonParser.class).build(); boolean decoding, validateEnd; /** * Constructor, default settings. */ protected Builder() { consumes("text/uon"); decoding = env("UonParser.decoding", false); validateEnd = env("UonParser.validateEnd", false); } /** * Copy constructor. * * @param copyFrom The bean to copy from. */ protected Builder(UonParser copyFrom) { super(copyFrom); decoding = copyFrom.decoding; validateEnd = copyFrom.validateEnd; } /** * Copy constructor. * * @param copyFrom The builder to copy from. */ protected Builder(Builder copyFrom) { super(copyFrom); decoding = copyFrom.decoding; validateEnd = copyFrom.validateEnd; } @Override /* Context.Builder */ public Builder copy() { return new Builder(this); } @Override /* Context.Builder */ public UonParser build() { return cache(CACHE).build(UonParser.class); } @Override /* Context.Builder */ public HashKey hashKey() { return HashKey.of( super.hashKey(), decoding, validateEnd ); } //----------------------------------------------------------------------------------------------------------------- // Properties //----------------------------------------------------------------------------------------------------------------- /** * Decode "%xx" sequences. * *

* When enabled, URI encoded characters will be decoded. Otherwise it's assumed that they've already been decoded * before being passed to this parser. * *

Example:
*

* // Create a decoding UON parser. * ReaderParser parser = UonParser. * .create() * .decoding() * .build(); * * // Produces: ["foo bar", "baz quz"]. * String[] foo = parser.parse("@(foo%20bar,baz%20qux)", String[].class); *

* * @return This object. */ @FluentSetter public Builder decoding() { return decoding(true); } /** * Same as {@link #decoding()} but allows you to explicitly specify the value. * * @param value The value for this setting. * @return This object. */ @FluentSetter public Builder decoding(boolean value) { decoding = value; return this; } /** * Validate end. * *

* When enabled, after parsing a POJO from the input, verifies that the remaining input in * the stream consists of only comments or whitespace. * *

Example:
*

* // Create a parser using strict mode. * ReaderParser parser = UonParser. * .create() * .validateEnd() * .build(); * * // Should fail because input has multiple POJOs. * String in = "(foo=bar)(baz=qux)"; * MyBean myBean = parser.parse(in, MyBean.class); *

* * @return This object. */ @FluentSetter public Builder validateEnd() { return validateEnd(true); } /** * Same as {@link #validateEnd()} but allows you to explicitly specify the value. * * @param value The value for this setting. * @return This object. */ @FluentSetter public Builder validateEnd(boolean value) { validateEnd = value; return this; } // @Override /* GENERATED - org.apache.juneau.Context.Builder */ public Builder annotations(Annotation...values) { super.annotations(values); return this; } @Override /* GENERATED - org.apache.juneau.Context.Builder */ public Builder apply(AnnotationWorkList work) { super.apply(work); return this; } @Override /* GENERATED - org.apache.juneau.Context.Builder */ public Builder applyAnnotations(java.lang.Class...fromClasses) { super.applyAnnotations(fromClasses); return this; } @Override /* GENERATED - org.apache.juneau.Context.Builder */ public Builder applyAnnotations(Method...fromMethods) { super.applyAnnotations(fromMethods); return this; } @Override /* GENERATED - org.apache.juneau.Context.Builder */ public Builder cache(Cache value) { super.cache(value); return this; } @Override /* GENERATED - org.apache.juneau.Context.Builder */ public Builder debug() { super.debug(); return this; } @Override /* GENERATED - org.apache.juneau.Context.Builder */ public Builder debug(boolean value) { super.debug(value); return this; } @Override /* GENERATED - org.apache.juneau.Context.Builder */ public Builder impl(Context value) { super.impl(value); return this; } @Override /* GENERATED - org.apache.juneau.Context.Builder */ public Builder type(Class value) { super.type(value); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder beanClassVisibility(Visibility value) { super.beanClassVisibility(value); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder beanConstructorVisibility(Visibility value) { super.beanConstructorVisibility(value); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder beanContext(BeanContext value) { super.beanContext(value); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder beanContext(BeanContext.Builder value) { super.beanContext(value); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder beanDictionary(java.lang.Class...values) { super.beanDictionary(values); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder beanFieldVisibility(Visibility value) { super.beanFieldVisibility(value); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder beanInterceptor(Class on, Class> value) { super.beanInterceptor(on, value); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder beanMapPutReturnsOldValue() { super.beanMapPutReturnsOldValue(); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder beanMethodVisibility(Visibility value) { super.beanMethodVisibility(value); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder beanProperties(Map values) { super.beanProperties(values); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder beanProperties(Class beanClass, String properties) { super.beanProperties(beanClass, properties); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder beanProperties(String beanClassName, String properties) { super.beanProperties(beanClassName, properties); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder beanPropertiesExcludes(Map values) { super.beanPropertiesExcludes(values); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder beanPropertiesExcludes(Class beanClass, String properties) { super.beanPropertiesExcludes(beanClass, properties); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder beanPropertiesExcludes(String beanClassName, String properties) { super.beanPropertiesExcludes(beanClassName, properties); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder beanPropertiesReadOnly(Map values) { super.beanPropertiesReadOnly(values); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder beanPropertiesReadOnly(Class beanClass, String properties) { super.beanPropertiesReadOnly(beanClass, properties); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder beanPropertiesReadOnly(String beanClassName, String properties) { super.beanPropertiesReadOnly(beanClassName, properties); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder beanPropertiesWriteOnly(Map values) { super.beanPropertiesWriteOnly(values); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder beanPropertiesWriteOnly(Class beanClass, String properties) { super.beanPropertiesWriteOnly(beanClass, properties); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder beanPropertiesWriteOnly(String beanClassName, String properties) { super.beanPropertiesWriteOnly(beanClassName, properties); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder beansRequireDefaultConstructor() { super.beansRequireDefaultConstructor(); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder beansRequireSerializable() { super.beansRequireSerializable(); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder beansRequireSettersForGetters() { super.beansRequireSettersForGetters(); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder dictionaryOn(Class on, java.lang.Class...values) { super.dictionaryOn(on, values); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder disableBeansRequireSomeProperties() { super.disableBeansRequireSomeProperties(); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder disableIgnoreMissingSetters() { super.disableIgnoreMissingSetters(); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder disableIgnoreTransientFields() { super.disableIgnoreTransientFields(); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder disableIgnoreUnknownNullBeanProperties() { super.disableIgnoreUnknownNullBeanProperties(); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder disableInterfaceProxies() { super.disableInterfaceProxies(); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder example(Class pojoClass, T o) { super.example(pojoClass, o); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder example(Class pojoClass, String json) { super.example(pojoClass, json); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder findFluentSetters() { super.findFluentSetters(); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder findFluentSetters(Class on) { super.findFluentSetters(on); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder ignoreInvocationExceptionsOnGetters() { super.ignoreInvocationExceptionsOnGetters(); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder ignoreInvocationExceptionsOnSetters() { super.ignoreInvocationExceptionsOnSetters(); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder ignoreUnknownBeanProperties() { super.ignoreUnknownBeanProperties(); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder ignoreUnknownEnumValues() { super.ignoreUnknownEnumValues(); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder implClass(Class interfaceClass, Class implClass) { super.implClass(interfaceClass, implClass); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder implClasses(Map,Class> values) { super.implClasses(values); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder interfaceClass(Class on, Class value) { super.interfaceClass(on, value); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder interfaces(java.lang.Class...value) { super.interfaces(value); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder locale(Locale value) { super.locale(value); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder mediaType(MediaType value) { super.mediaType(value); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder notBeanClasses(java.lang.Class...values) { super.notBeanClasses(values); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder notBeanPackages(String...values) { super.notBeanPackages(values); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder propertyNamer(Class value) { super.propertyNamer(value); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder propertyNamer(Class on, Class value) { super.propertyNamer(on, value); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder sortProperties() { super.sortProperties(); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder sortProperties(java.lang.Class...on) { super.sortProperties(on); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder stopClass(Class on, Class value) { super.stopClass(on, value); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder swap(Class normalClass, Class swappedClass, ThrowingFunction swapFunction) { super.swap(normalClass, swappedClass, swapFunction); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder swap(Class normalClass, Class swappedClass, ThrowingFunction swapFunction, ThrowingFunction unswapFunction) { super.swap(normalClass, swappedClass, swapFunction, unswapFunction); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder swaps(java.lang.Class...values) { super.swaps(values); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder timeZone(TimeZone value) { super.timeZone(value); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder typeName(Class on, String value) { super.typeName(on, value); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder typePropertyName(String value) { super.typePropertyName(value); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder typePropertyName(Class on, String value) { super.typePropertyName(on, value); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder useEnumNames() { super.useEnumNames(); return this; } @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */ public Builder useJavaBeanIntrospector() { super.useJavaBeanIntrospector(); return this; } @Override /* GENERATED - org.apache.juneau.parser.Parser.Builder */ public Builder autoCloseStreams() { super.autoCloseStreams(); return this; } @Override /* GENERATED - org.apache.juneau.parser.Parser.Builder */ public Builder autoCloseStreams(boolean value) { super.autoCloseStreams(value); return this; } @Override /* GENERATED - org.apache.juneau.parser.Parser.Builder */ public Builder consumes(String value) { super.consumes(value); return this; } @Override /* GENERATED - org.apache.juneau.parser.Parser.Builder */ public Builder debugOutputLines(int value) { super.debugOutputLines(value); return this; } @Override /* GENERATED - org.apache.juneau.parser.Parser.Builder */ public Builder listener(Class value) { super.listener(value); return this; } @Override /* GENERATED - org.apache.juneau.parser.Parser.Builder */ public Builder strict() { super.strict(); return this; } @Override /* GENERATED - org.apache.juneau.parser.Parser.Builder */ public Builder strict(boolean value) { super.strict(value); return this; } @Override /* GENERATED - org.apache.juneau.parser.Parser.Builder */ public Builder trimStrings() { super.trimStrings(); return this; } @Override /* GENERATED - org.apache.juneau.parser.Parser.Builder */ public Builder trimStrings(boolean value) { super.trimStrings(value); return this; } @Override /* GENERATED - org.apache.juneau.parser.Parser.Builder */ public Builder unbuffered() { super.unbuffered(); return this; } @Override /* GENERATED - org.apache.juneau.parser.Parser.Builder */ public Builder unbuffered(boolean value) { super.unbuffered(value); return this; } @Override /* GENERATED - org.apache.juneau.parser.ReaderParser.Builder */ public Builder fileCharset(Charset value) { super.fileCharset(value); return this; } @Override /* GENERATED - org.apache.juneau.parser.ReaderParser.Builder */ public Builder streamCharset(Charset value) { super.streamCharset(value); return this; } // } //------------------------------------------------------------------------------------------------------------------- // Instance //------------------------------------------------------------------------------------------------------------------- final boolean decoding, validateEnd; private final Map,UonClassMeta> uonClassMetas = new ConcurrentHashMap<>(); private final Map uonBeanPropertyMetas = new ConcurrentHashMap<>(); /** * Constructor. * * @param builder The builder for this object. */ public UonParser(Builder builder) { super(builder); decoding = builder.decoding; validateEnd = builder.validateEnd; } @Override /* Context */ public Builder copy() { return new Builder(this); } @Override /* Context */ public UonParserSession.Builder createSession() { return UonParserSession.create(this); } @Override /* Context */ public UonParserSession getSession() { return createSession().build(); } @Override /* HttpPartParser */ public UonParserSession getPartSession() { return UonParserSession.create(this).build(); } /** * Converts the specified input to the specified class type. * * @param The POJO type to transform the input into. * @param partType The part type being parsed. * @param schema * Schema information about the part. *
May be null. *
Not all part parsers use the schema information. * @param in The input being parsed. * @param toType The POJO type to transform the input into. * @return The parsed value. * @throws ParseException Malformed input encountered. * @throws SchemaValidationException If the input or resulting HTTP part object fails schema validation. */ public T parse(HttpPartType partType, HttpPartSchema schema, String in, ClassMeta toType) throws ParseException, SchemaValidationException { return getPartSession().parse(partType, schema, in, toType); } /** * Converts the specified input to the specified class type. * * @param The POJO type to transform the input into. * @param partType The part type being parsed. * @param schema * Schema information about the part. *
May be null. *
Not all part parsers use the schema information. * @param in The input being parsed. * @param toType The POJO type to transform the input into. * @return The parsed value. * @throws ParseException Malformed input encountered. * @throws SchemaValidationException If the input or resulting HTTP part object fails schema validation. */ public T parse(HttpPartType partType, HttpPartSchema schema, String in, Class toType) throws ParseException, SchemaValidationException { return getPartSession().parse(partType, schema, in, getClassMeta(toType)); } /** * Converts the specified input to the specified class type. * * @param The POJO type to transform the input into. * @param partType The part type being parsed. * @param schema * Schema information about the part. *
May be null. *
Not all part parsers use the schema information. * @param in The input being parsed. * @param toType The POJO type to transform the input into. * @param toTypeArgs The generic type arguments of the POJO type to transform the input into. * @return The parsed value. * @throws ParseException Malformed input encountered. * @throws SchemaValidationException If the input or resulting HTTP part object fails schema validation. */ public T parse(HttpPartType partType, HttpPartSchema schema, String in, Type toType, Type...toTypeArgs) throws ParseException, SchemaValidationException { return getPartSession().parse(partType, schema, in, getClassMeta(toType, toTypeArgs)); } //----------------------------------------------------------------------------------------------------------------- // Extended metadata //----------------------------------------------------------------------------------------------------------------- @Override /* UonMetaProvider */ public UonClassMeta getUonClassMeta(ClassMeta cm) { UonClassMeta m = uonClassMetas.get(cm); if (m == null) { m = new UonClassMeta(cm, this); uonClassMetas.put(cm, m); } return m; } @Override /* UonMetaProvider */ public UonBeanPropertyMeta getUonBeanPropertyMeta(BeanPropertyMeta bpm) { if (bpm == null) return UonBeanPropertyMeta.DEFAULT; UonBeanPropertyMeta m = uonBeanPropertyMetas.get(bpm); if (m == null) { m = new UonBeanPropertyMeta(bpm.getDelegateFor(), this); uonBeanPropertyMetas.put(bpm, m); } return m; } //----------------------------------------------------------------------------------------------------------------- // Properties //----------------------------------------------------------------------------------------------------------------- /** * Decode "%xx" sequences enabled * * @see Builder#decoding() * @return * true if URI encoded characters should be decoded, false if they've already been decoded * before being passed to this parser. */ protected final boolean isDecoding() { return decoding; } /** * Validate end enabled. * * @see Builder#validateEnd() * @return * true if after parsing a POJO from the input, verifies that the remaining input in * the stream consists of only comments or whitespace. */ protected final boolean isValidateEnd() { return validateEnd; } //----------------------------------------------------------------------------------------------------------------- // Other methods //----------------------------------------------------------------------------------------------------------------- @Override public ClassMeta getClassMeta(Class c) { return getBeanContext().getClassMeta(c); } @Override public ClassMeta getClassMeta(Type t, Type... args) { return getBeanContext().getClassMeta(t, args); } @Override /* Context */ protected JsonMap properties() { return filteredMap("decoding", decoding, "validateEnd", validateEnd); } }