org.apache.juneau.html.HtmlSchemaSerializer 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.html;
import org.apache.juneau.*;
import org.apache.juneau.jsonschema.*;
import org.apache.juneau.serializer.*;
/**
* Serializes POJO metamodels to HTML.
*
* Media types
*
* Handles Accept types: text/html+schema
*
* Produces Content-Type types: text/html
*
*
Description
*
* Essentially the same as {@link HtmlSerializer}, except serializes the POJO metamodel instead of the model itself.
*
*
* Produces output that describes the POJO metamodel similar to an XML schema document.
*
*
* The easiest way to create instances of this class is through the {@link HtmlSerializer#getSchemaSerializer()},
* which will create a schema serializer with the same settings as the originating serializer.
*/
public class HtmlSchemaSerializer extends HtmlSerializer {
/** Default serializer, all default settings.*/
public static final HtmlSchemaSerializer DEFAULT = new HtmlSchemaSerializer(PropertyStore.DEFAULT);
/** Default serializer, all default settings.*/
public static final HtmlSchemaSerializer DEFAULT_READABLE = new Readable(PropertyStore.DEFAULT);
/** Default serializer, single quotes, simple mode. */
public static final HtmlSchemaSerializer DEFAULT_SIMPLE = new Simple(PropertyStore.DEFAULT);
/** Default serializer, single quotes, simple mode, with whitespace. */
public static final HtmlSchemaSerializer DEFAULT_SIMPLE_READABLE = new SimpleReadable(PropertyStore.DEFAULT);
//-------------------------------------------------------------------------------------------------------------------
// Predefined subclasses
//-------------------------------------------------------------------------------------------------------------------
/** Default serializer, with whitespace. */
public static class Readable extends HtmlSchemaSerializer {
/**
* Constructor.
*
* @param ps The property store containing all the settings for this object.
*/
public Readable(PropertyStore ps) {
super(
ps.builder().set(SERIALIZER_useWhitespace, true).build()
);
}
}
/** Default serializer, single quotes, simple mode. */
public static class Simple extends HtmlSchemaSerializer {
/**
* Constructor.
*
* @param ps The property store containing all the settings for this object.
*/
public Simple(PropertyStore ps) {
super(
ps.builder()
.set(WSERIALIZER_quoteChar, '\'')
.build()
);
}
}
/** Default serializer, single quotes, simple mode, with whitespace. */
public static class SimpleReadable extends HtmlSchemaSerializer {
/**
* Constructor.
*
* @param ps The property store containing all the settings for this object.
*/
public SimpleReadable(PropertyStore ps) {
super(
ps.builder()
.set(WSERIALIZER_quoteChar, '\'')
.set(SERIALIZER_useWhitespace, true)
.build()
);
}
}
//-------------------------------------------------------------------------------------------------------------------
// Instance
//-------------------------------------------------------------------------------------------------------------------
private final JsonSchemaGenerator generator;
/**
* Constructor.
*
* @param ps
* The property store to use for creating the context for this serializer.
*/
public HtmlSchemaSerializer(PropertyStore ps) {
super(
ps.builder()
.set(BEANTRAVERSE_detectRecursions, true)
.set(BEANTRAVERSE_ignoreRecursions, true)
.build(),
"text/html", "text/html+schema"
);
generator = JsonSchemaGenerator.create().apply(getPropertyStore()).build();
}
@Override /* Context */
public HtmlSchemaSerializerBuilder builder() {
return new HtmlSchemaSerializerBuilder(getPropertyStore());
}
@Override /* Serializer */
public HtmlSchemaSerializerSession createSession(SerializerSessionArgs args) {
return new HtmlSchemaSerializerSession(this, args);
}
@Override /* Context */
public HtmlSchemaSerializerSession createSession() {
return createSession(createDefaultSessionArgs());
}
JsonSchemaGenerator getGenerator() {
return generator;
}
}