blob: d3e7139f768001831cd5bd87d8d03a680c805238 [file] [log] [blame]
// ***************************************************************************************************************************
// * 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.parser;
import static org.apache.juneau.parser.InputStreamParser.*;
import static org.apache.juneau.parser.ReaderParser.*;
import java.lang.annotation.*;
import java.lang.reflect.*;
import java.nio.charset.*;
import java.util.*;
import org.apache.juneau.*;
import org.apache.juneau.collections.*;
import org.apache.juneau.http.*;
import org.apache.juneau.internal.*;
import org.apache.juneau.reflect.*;
import org.apache.juneau.svl.*;
/**
* Builder class for creating instances of {@link ParserGroup}.
*/
public class ParserGroupBuilder extends BeanContextBuilder {
private final AList<Object> parsers;
/**
* Create an empty parser group builder.
*/
public ParserGroupBuilder() {
this.parsers = AList.create();
}
/**
* Clone an existing parser group builder.
*
* @param copyFrom The parser group that we're copying settings and parsers from.
*/
public ParserGroupBuilder(ParserGroup copyFrom) {
super(copyFrom.getPropertyStore());
this.parsers = AList.create().appendReverse(copyFrom.getParsers());
}
/**
* Registers the specified parsers with this group.
*
* @param p The parsers to append to this group.
* @return This object (for method chaining).
*/
public ParserGroupBuilder append(Class<?>...p) {
parsers.appendReverse((Object[])p);
return this;
}
/**
* Registers the specified parsers with this group.
*
* <p>
* When passing in pre-instantiated parsers to this group, applying properties and transforms to the group
* do not affect them.
*
* @param p The parsers to append to this group.
* @return This object (for method chaining).
*/
public ParserGroupBuilder append(Parser...p) {
parsers.appendReverse((Object[])p);
return this;
}
/**
* Registers the specified parsers with this group.
*
* <p>
* Objects can either be instances of parsers or parser classes.
*
* @param p The parsers to append to this group.
* @return This object (for method chaining).
*/
public ParserGroupBuilder append(List<Object> p) {
parsers.appendReverse(p);
return this;
}
/**
* Registers the specified parsers with this group.
*
* <p>
* Objects can either be instances of parsers or parser classes.
*
* @param p The parsers to append to this group.
* @return This object (for method chaining).
*/
public ParserGroupBuilder append(Object...p) {
parsers.appendReverse(p);
return this;
}
/**
* Creates a new {@link ParserGroup} object using a snapshot of the settings defined in this builder.
*
* <p>
* This method can be called multiple times to produce multiple parser groups.
*
* @return A new {@link ParserGroup} object.
*/
@Override /* Context */
@SuppressWarnings("unchecked")
public ParserGroup build() {
List<Parser> l = new ArrayList<>();
for (Object p : parsers) {
Class<? extends Parser> c = null;
PropertyStore ps = getPropertyStore();
if (p instanceof Class) {
c = (Class<? extends Parser>)p;
l.add(ContextCache.INSTANCE.create(c, ps));
} else {
l.add((Parser)p);
}
}
return new ParserGroup(getPropertyStore(), ArrayUtils.toReverseArray(Parser.class, l));
}
//-----------------------------------------------------------------------------------------------------------------
// Properties
//-----------------------------------------------------------------------------------------------------------------
/**
* Configuration property: Auto-close streams.
*
* <p>
* If <jk>true</jk>, <l>InputStreams</l> and <l>Readers</l> passed into parsers will be closed
* after parsing is complete.
*
* <ul class='seealso'>
* <li class='jf'>{@link Parser#PARSER_autoCloseStreams}
* </ul>
*
* @param value
* The new value for this property.
* <br>The default value is <jk>false</jk>.
* @return This object (for method chaining).
*/
public ParserGroupBuilder autoCloseStreams(boolean value) {
return set(PARSER_autoCloseStreams, value);
}
/**
* Configuration property: Auto-close streams.
* <p>
* Shortcut for calling <code>autoCloseStreams(<jk>true</jk>)</code>.
*
* <ul class='seealso'>
* <li class='jf'>{@link Parser#PARSER_autoCloseStreams}
* </ul>
*
* @return This object (for method chaining).
*/
public ParserGroupBuilder autoCloseStreams() {
return set(PARSER_autoCloseStreams);
}
/**
* Configuration property: Debug output lines.
*
* When parse errors occur, this specifies the number of lines of input before and after the
* error location to be printed as part of the exception message.
*
* <ul class='seealso'>
* <li class='jf'>{@link Parser#PARSER_debugOutputLines}
* </ul>
*
* @param value
* The new value for this property.
* <br>The default value is <c>5</c>.
* @return This object (for method chaining).
*/
public ParserGroupBuilder debugOutputLines(int value) {
set(PARSER_debugOutputLines, value);
return this;
}
/**
* Configuration property: Parser listener.
*
* <p>
* Class used to listen for errors and warnings that occur during parsing.
*
* <ul class='seealso'>
* <li class='jf'>{@link Parser#PARSER_listener}
* </ul>
*
* @param value The new value for this property.
* @return This object (for method chaining).
*/
public ParserGroupBuilder listener(Class<? extends ParserListener> value) {
return set(PARSER_listener, value);
}
/**
* Configuration property: Strict mode.
*
* <p>
* If <jk>true</jk>, strict mode for the parsers are enabled.
*
* <ul class='seealso'>
* <li class='jf'>{@link Parser#PARSER_strict}
* </ul>
*
* @param value
* The new value for this property.
* <br>The default value is <jk>false</jk>.
* @return This object (for method chaining).
*/
public ParserGroupBuilder strict(boolean value) {
return set(PARSER_strict, value);
}
/**
* Configuration property: Strict mode.
*
* <p>
* Shortcut for calling <code>strict(<jk>true</jk>)</code>.
*
* <ul class='seealso'>
* <li class='jf'>{@link Parser#PARSER_strict}
* </ul>
*
* @return This object (for method chaining).
*/
public ParserGroupBuilder strict() {
return set(PARSER_strict);
}
/**
* Configuration property: Trim parsed strings.
*
* <p>
* If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being added to
* the POJO.
*
* <ul class='seealso'>
* <li class='jf'>{@link Parser#PARSER_trimStrings}
* </ul>
*
* @param value
* The new value for this property.
* <br>The default value is <jk>false</jk>.
* @return This object (for method chaining).
*/
public ParserGroupBuilder trimStrings(boolean value) {
return set(PARSER_trimStrings, value);
}
/**
* Configuration property: Trim parsed strings.
*
* <p>
* Shortcut for calling <code>trimStrings(<jk>true</jk>)</code>.
*
* <ul class='seealso'>
* <li class='jf'>{@link Parser#PARSER_trimStrings}
* </ul>
*
* @return This object (for method chaining).
*/
public ParserGroupBuilder trimStrings() {
return set(PARSER_trimStrings);
}
/**
* Configuration property: Unbuffered.
*
* <p>
* If <jk>true</jk>, don't use internal buffering during parsing.
*
* <ul class='seealso'>
* <li class='jf'>{@link Parser#PARSER_unbuffered}
* </ul>
*
* @param value
* The new value for this property.
* <br>The default value is <jk>false</jk>.
* @return This object (for method chaining).
*/
public ParserGroupBuilder unbuffered(boolean value) {
return set(PARSER_unbuffered, value);
}
/**
* Configuration property: Unbuffered.
*
* <p>
* Shortcut for calling <code>unbuffered(<jk>true</jk>)</code>.
*
* <ul class='seealso'>
* <li class='jf'>{@link Parser#PARSER_unbuffered}
* </ul>
*
* @return This object (for method chaining).
*/
public ParserGroupBuilder unbuffered() {
return set(PARSER_unbuffered);
}
/**
* Configuration property: File charset.
*
* <p>
* The character set to use for reading <c>Files</c> from the file system.
*
* <ul class='seealso'>
* <li class='jf'>{@link ReaderParser#RPARSER_fileCharset}
* </ul>
*
* @param value
* The new value for this property.
* <br>The default value is <js>"DEFAULT"</js> which causes the system default to be used.
* @return This object (for method chaining).
*/
public ParserGroupBuilder fileCharset(Charset value) {
return set(RPARSER_fileCharset, value);
}
/**
* Configuration property: Input stream charset.
*
* <p>
* The character set to use for converting <c>InputStreams</c> and byte arrays to readers.
*
* <ul class='seealso'>
* <li class='jf'>{@link ReaderParser#RPARSER_streamCharset}
* </ul>
*
* @param value
* The new value for this property.
* <br>The default value is <js>"UTF-8"</js>.
* @return This object (for method chaining).
*/
public ParserGroupBuilder streamCharset(Charset value) {
return set(RPARSER_streamCharset, value);
}
/**
* Configuration property: Binary input format.
*
* <p>
* When using the {@link Parser#parse(Object,Class)} method on stream-based parsers and the input is a string, this defines the format to use
* when converting the string into a byte array.
*
* <ul class='seealso'>
* <li class='jf'>{@link InputStreamParser#ISPARSER_binaryFormat}
* </ul>
*
* @param value
* The new value for this property.
* <br>The default value is {@link BinaryFormat#HEX}.
* @return This object (for method chaining).
*/
public ParserGroupBuilder binaryFormat(BinaryFormat value) {
return set(ISPARSER_binaryFormat, value);
}
// <FluentSetters>
@Override /* GENERATED - ContextBuilder */
public ParserGroupBuilder add(Map<String,Object> properties) {
super.add(properties);
return this;
}
@Override /* GENERATED - ContextBuilder */
public ParserGroupBuilder addTo(String name, Object value) {
super.addTo(name, value);
return this;
}
@Override /* GENERATED - ContextBuilder */
public ParserGroupBuilder appendTo(String name, Object value) {
super.appendTo(name, value);
return this;
}
@Override /* GENERATED - ContextBuilder */
public ParserGroupBuilder apply(PropertyStore copyFrom) {
super.apply(copyFrom);
return this;
}
@Override /* GENERATED - ContextBuilder */
public ParserGroupBuilder applyAnnotations(java.lang.Class<?>...fromClasses) {
super.applyAnnotations(fromClasses);
return this;
}
@Override /* GENERATED - ContextBuilder */
public ParserGroupBuilder applyAnnotations(Method...fromMethods) {
super.applyAnnotations(fromMethods);
return this;
}
@Override /* GENERATED - ContextBuilder */
public ParserGroupBuilder applyAnnotations(AnnotationList al, VarResolverSession r) {
super.applyAnnotations(al, r);
return this;
}
@Override /* GENERATED - ContextBuilder */
public ParserGroupBuilder debug() {
super.debug();
return this;
}
@Override /* GENERATED - ContextBuilder */
public ParserGroupBuilder locale(Locale value) {
super.locale(value);
return this;
}
@Override /* GENERATED - ContextBuilder */
public ParserGroupBuilder mediaType(MediaType value) {
super.mediaType(value);
return this;
}
@Override /* GENERATED - ContextBuilder */
public ParserGroupBuilder prependTo(String name, Object value) {
super.prependTo(name, value);
return this;
}
@Override /* GENERATED - ContextBuilder */
public ParserGroupBuilder putAllTo(String name, Object value) {
super.putAllTo(name, value);
return this;
}
@Override /* GENERATED - ContextBuilder */
public ParserGroupBuilder putTo(String name, String key, Object value) {
super.putTo(name, key, value);
return this;
}
@Override /* GENERATED - ContextBuilder */
public ParserGroupBuilder removeFrom(String name, Object value) {
super.removeFrom(name, value);
return this;
}
@Override /* GENERATED - ContextBuilder */
public ParserGroupBuilder set(String name) {
super.set(name);
return this;
}
@Override /* GENERATED - ContextBuilder */
public ParserGroupBuilder set(Map<String,Object> properties) {
super.set(properties);
return this;
}
@Override /* GENERATED - ContextBuilder */
public ParserGroupBuilder set(String name, Object value) {
super.set(name, value);
return this;
}
@Override /* GENERATED - ContextBuilder */
public ParserGroupBuilder timeZone(TimeZone value) {
super.timeZone(value);
return this;
}
@Override /* GENERATED - ContextBuilder */
public ParserGroupBuilder unset(String name) {
super.unset(name);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder annotations(Annotation...values) {
super.annotations(values);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder beanClassVisibility(Visibility value) {
super.beanClassVisibility(value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder beanConstructorVisibility(Visibility value) {
super.beanConstructorVisibility(value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder beanFieldVisibility(Visibility value) {
super.beanFieldVisibility(value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder beanInterceptor(Class<?> on, Class<? extends org.apache.juneau.transform.BeanInterceptor<?>> value) {
super.beanInterceptor(on, value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder beanMapPutReturnsOldValue() {
super.beanMapPutReturnsOldValue();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder beanMethodVisibility(Visibility value) {
super.beanMethodVisibility(value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder beanProperties(Map<String,Object> values) {
super.beanProperties(values);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder beanProperties(Class<?> beanClass, String properties) {
super.beanProperties(beanClass, properties);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder beanProperties(String beanClassName, String properties) {
super.beanProperties(beanClassName, properties);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder beanPropertiesExcludes(Map<String,Object> values) {
super.beanPropertiesExcludes(values);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder beanPropertiesExcludes(Class<?> beanClass, String properties) {
super.beanPropertiesExcludes(beanClass, properties);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder beanPropertiesExcludes(String beanClassName, String properties) {
super.beanPropertiesExcludes(beanClassName, properties);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder beanPropertiesReadOnly(Map<String,Object> values) {
super.beanPropertiesReadOnly(values);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder beanPropertiesReadOnly(Class<?> beanClass, String properties) {
super.beanPropertiesReadOnly(beanClass, properties);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder beanPropertiesReadOnly(String beanClassName, String properties) {
super.beanPropertiesReadOnly(beanClassName, properties);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder beanPropertiesWriteOnly(Map<String,Object> values) {
super.beanPropertiesWriteOnly(values);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder beanPropertiesWriteOnly(Class<?> beanClass, String properties) {
super.beanPropertiesWriteOnly(beanClass, properties);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder beanPropertiesWriteOnly(String beanClassName, String properties) {
super.beanPropertiesWriteOnly(beanClassName, properties);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder beansRequireDefaultConstructor() {
super.beansRequireDefaultConstructor();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder beansRequireSerializable() {
super.beansRequireSerializable();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder beansRequireSettersForGetters() {
super.beansRequireSettersForGetters();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder dictionary(Object...values) {
super.dictionary(values);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder dictionaryOn(Class<?> on, java.lang.Class<?>...values) {
super.dictionaryOn(on, values);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder disableBeansRequireSomeProperties() {
super.disableBeansRequireSomeProperties();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder disableIgnoreMissingSetters() {
super.disableIgnoreMissingSetters();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder disableIgnoreTransientFields() {
super.disableIgnoreTransientFields();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder disableIgnoreUnknownNullBeanProperties() {
super.disableIgnoreUnknownNullBeanProperties();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder disableInterfaceProxies() {
super.disableInterfaceProxies();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public <T> ParserGroupBuilder example(Class<T> pojoClass, T o) {
super.example(pojoClass, o);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public <T> ParserGroupBuilder example(Class<T> pojoClass, String json) {
super.example(pojoClass, json);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder findFluentSetters() {
super.findFluentSetters();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder findFluentSetters(Class<?> on) {
super.findFluentSetters(on);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder ignoreInvocationExceptionsOnGetters() {
super.ignoreInvocationExceptionsOnGetters();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder ignoreInvocationExceptionsOnSetters() {
super.ignoreInvocationExceptionsOnSetters();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder ignoreUnknownBeanProperties() {
super.ignoreUnknownBeanProperties();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder implClass(Class<?> interfaceClass, Class<?> implClass) {
super.implClass(interfaceClass, implClass);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder implClasses(Map<Class<?>,Class<?>> values) {
super.implClasses(values);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder interfaceClass(Class<?> on, Class<?> value) {
super.interfaceClass(on, value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder interfaces(java.lang.Class<?>...value) {
super.interfaces(value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder notBeanClasses(Object...values) {
super.notBeanClasses(values);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder notBeanPackages(Object...values) {
super.notBeanPackages(values);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder propertyNamer(Class<? extends org.apache.juneau.PropertyNamer> value) {
super.propertyNamer(value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder propertyNamer(Class<?> on, Class<? extends org.apache.juneau.PropertyNamer> value) {
super.propertyNamer(on, value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder sortProperties() {
super.sortProperties();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder sortProperties(java.lang.Class<?>...on) {
super.sortProperties(on);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder stopClass(Class<?> on, Class<?> value) {
super.stopClass(on, value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder swaps(Object...values) {
super.swaps(values);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder typeName(Class<?> on, String value) {
super.typeName(on, value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder typePropertyName(String value) {
super.typePropertyName(value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder typePropertyName(Class<?> on, String value) {
super.typePropertyName(on, value);
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder useEnumNames() {
super.useEnumNames();
return this;
}
@Override /* GENERATED - BeanContextBuilder */
public ParserGroupBuilder useJavaBeanIntrospector() {
super.useJavaBeanIntrospector();
return this;
}
// </FluentSetters>
}