nl.rrd.wool.i18n.WoolTranslatable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wool-core Show documentation
WOOL is a simple, powerful dialogue framework for creating virtual agent conversations.
The newest version!
/*
 * Copyright 2019 Roessingh Research and Development.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

package nl.rrd.wool.i18n;

import nl.rrd.wool.model.WoolNodeBody;
import nl.rrd.wool.model.command.WoolInputCommand;

import java.util.List;

/**
 * This class models a translatable segment from a WOOL node. It basically
 * consists of plain text, variables and <<input>> commands.
 *
 * The class contains {@link WoolNodeBody.TextSegment TextSegment}s (with
 * plain text and variables) and {@link WoolNodeBody.CommandSegment
 * CommandSegment}s where the command is a {@link WoolInputCommand
 * WoolInputCommand}.
 *
 * Instances of this class can be obtained from {@link
 * WoolTranslatableExtractor WoolTranslatableExtractor} or {@link
 * WoolTranslationParser WoolTranslationParser}.
 *
 * @author Dennis Hofs (RRD)
 */
public class WoolTranslatable {
	private WoolNodeBody parent;
	private List segments;

	/**
	 * Constructs a new WOOL translatable.
	 *
	 * @param parent the parent (used in {@link WoolTranslator WoolTranslator})
	 * @param segments the segments
	 */
	public WoolTranslatable(WoolNodeBody parent,
			List segments) {
		this.parent = parent;
		this.segments = segments;
	}

	/**
	 * Returns the parent (used in {@link WoolTranslator WoolTranslator}).
	 *
	 * @return the parent (used in {@link WoolTranslator WoolTranslator})
	 */
	public WoolNodeBody getParent() {
		return parent;
	}

	/**
	 * Returns the translatable segment.
	 *
	 * @return the translatable segment
	 */
	public List getSegments() {
		return segments;
	}

	@Override
	public int hashCode() {
		return toString().hashCode();
	}

	@Override
	public boolean equals(Object obj) {
		if (obj == null)
			return false;
		if (obj.getClass() != getClass())
			return false;
		WoolTranslatable other = (WoolTranslatable)obj;
		return toString().equals(other.toString());
	}

	@Override
	public String toString() {
		StringBuilder builder = new StringBuilder();
		for (WoolNodeBody.Segment segment : segments) {
			builder.append(segment);
		}
		return builder.toString();
	}
}