com.phloc.commons.microdom.IMicroNodeWithChildren Maven / Gradle / Ivy
/**
* Copyright (C) 2006-2014 phloc systems
* http://www.phloc.com
* office[at]phloc[dot]com
*
* Licensed 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 com.phloc.commons.microdom;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
/**
* A special marker interface that is implemented by classes, that really
* support having children!
*
* @author Philip Helger
*/
public interface IMicroNodeWithChildren extends IMicroNode
{
/**
* Get the concatenated text content of all direct {@link IMicroText} child
* nodes of this element.
*
* @return null if the element contains no text node as child
*/
@Nullable
String getTextContent ();
/**
* Get the concatenated text content of all direct {@link IMicroText} child
* nodes of this element. After concatenation, all leading and trailing spaces
* are removed.
*
* @return null if the element contains no text node as child
*/
@Nullable
String getTextContentTrimmed ();
/**
* Get the concatenated text content of all direct {@link IMicroText} child
* nodes of this element. The value is converted via the
* {@link com.phloc.commons.typeconvert.TypeConverter} to the desired
* destination class.
*
* @param
* The destination type to convert the String textContent to.
* @param aDstClass
* The destination class to which the text content should be converted.
* @return null if the element contains no text node as child
*/
@Nullable
DSTTYPE getTextContentWithConversion (@Nonnull Class aDstClass);
/**
* {@inheritDoc}
*/
@Nonnull
IMicroNodeWithChildren getClone ();
}