// *************************************************************************************************************************** | |
// * 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 java.util.*; | |
import java.util.concurrent.*; | |
import org.apache.juneau.*; | |
import org.apache.juneau.annotation.*; | |
import org.apache.juneau.parser.*; | |
import org.apache.juneau.xml.*; | |
/** | |
* Parses text generated by the {@link HtmlSerializer} class back into a POJO model. | |
* | |
* <h5 class='topic'>Media types</h5> | |
* | |
* Handles <c>Content-Type</c> types: <bc>text/html</bc> | |
* | |
* <h5 class='topic'>Description</h5> | |
* | |
* See the {@link HtmlSerializer} class for a description of the HTML generated. | |
* <p> | |
* This class is used primarily for automated testing of the {@link HtmlSerializer} class. | |
*/ | |
@ConfigurableContext | |
public class HtmlParser extends XmlParser implements HtmlMetaProvider { | |
//------------------------------------------------------------------------------------------------------------------- | |
// Configurable properties | |
//------------------------------------------------------------------------------------------------------------------- | |
static final String PREFIX = "HtmlParser"; | |
//------------------------------------------------------------------------------------------------------------------- | |
// Predefined instances | |
//------------------------------------------------------------------------------------------------------------------- | |
/** Default parser, all default settings.*/ | |
public static final HtmlParser DEFAULT = new HtmlParser(PropertyStore.DEFAULT); | |
//------------------------------------------------------------------------------------------------------------------- | |
// Instance | |
//------------------------------------------------------------------------------------------------------------------- | |
private final Map<ClassMeta<?>,HtmlClassMeta> htmlClassMetas = new ConcurrentHashMap<>(); | |
private final Map<BeanPropertyMeta,HtmlBeanPropertyMeta> htmlBeanPropertyMetas = new ConcurrentHashMap<>(); | |
/** | |
* Constructor. | |
* | |
* @param ps The property store containing all the settings for this object. | |
*/ | |
public HtmlParser(PropertyStore ps) { | |
super(ps, "text/html", "text/html+stripped"); | |
} | |
@Override /* Context */ | |
public HtmlParserBuilder builder() { | |
return new HtmlParserBuilder(getPropertyStore()); | |
} | |
/** | |
* Instantiates a new clean-slate {@link HtmlParserBuilder} object. | |
* | |
* <p> | |
* This is equivalent to simply calling <code><jk>new</jk> HtmlParserBuilder()</code>. | |
* | |
* <p> | |
* Note that this method creates a builder initialized to all default settings, whereas {@link #builder()} copies | |
* the settings of the object called on. | |
* | |
* @return A new {@link HtmlParserBuilder} object. | |
*/ | |
public static HtmlParserBuilder create() { | |
return new HtmlParserBuilder(); | |
} | |
@Override /* Parser */ | |
public HtmlParserSession createSession() { | |
return createSession(createDefaultSessionArgs()); | |
} | |
@Override /* Parser */ | |
public HtmlParserSession createSession(ParserSessionArgs args) { | |
return new HtmlParserSession(this, args); | |
} | |
//----------------------------------------------------------------------------------------------------------------- | |
// Extended metadata | |
//----------------------------------------------------------------------------------------------------------------- | |
@Override /* HtmlMetaProvider */ | |
public HtmlClassMeta getHtmlClassMeta(ClassMeta<?> cm) { | |
HtmlClassMeta m = htmlClassMetas.get(cm); | |
if (m == null) { | |
m = new HtmlClassMeta(cm, this); | |
htmlClassMetas.put(cm, m); | |
} | |
return m; | |
} | |
@Override /* HtmlMetaProvider */ | |
public HtmlBeanPropertyMeta getHtmlBeanPropertyMeta(BeanPropertyMeta bpm) { | |
if (bpm == null) | |
return HtmlBeanPropertyMeta.DEFAULT; | |
HtmlBeanPropertyMeta m = htmlBeanPropertyMetas.get(bpm); | |
if (m == null) { | |
m = new HtmlBeanPropertyMeta(bpm.getDelegateFor(), this); | |
htmlBeanPropertyMetas.put(bpm, m); | |
} | |
return m; | |
} | |
//----------------------------------------------------------------------------------------------------------------- | |
// Other methods | |
//----------------------------------------------------------------------------------------------------------------- | |
@Override /* Context */ | |
public ObjectMap toMap() { | |
return super.toMap() | |
.append("HtmlParser", new DefaultFilteringObjectMap()); | |
} | |
} |