/*license*\
XBN-Java: Copyright (C) 2014, Jeff Epstein (aliteralmind __DASH__ github __AT__ yahoo __DOT__ com)
This software is dual-licensed under the:
- Lesser General Public License (LGPL) version 3.0 or, at your option, any later version;
- Apache Software License (ASL) version 2.0.
Either license may be applied at your discretion. More information may be found at
- http://en.wikipedia.org/wiki/Multi-licensing.
The text of both licenses is available in the root directory of this project, under the names "LICENSE_lgpl-3.0.txt" and "LICENSE_asl-2.0.txt". The latest copies may be downloaded at:
- LGPL 3.0: https://www.gnu.org/licenses/lgpl-3.0.txt
- ASL 2.0: http://www.apache.org/licenses/LICENSE-2.0.txt
\*license*/
package com.github.xbn.analyze.alter;
import com.github.xbn.lang.RuleType;
import com.github.xbn.analyze.AnalyzerComposer;
import com.github.xbn.lang.CrashIfObject;
import com.github.xbn.io.TextAppenter;
import com.github.xbn.analyze.Analyzer;
/**
<p>Abstract implementation of {@code ValueAlterer}.</p>
* @since 0.1.0
* @author Copyright (C) 2014, Jeff Epstein ({@code aliteralmind __DASH__ github __AT__ yahoo __DOT__ com}), dual-licensed under the LGPL (version 3.0 or later) or the ASL (version 2.0). See source code for details. <a href="http://xbnjava.aliteralmind.com">{@code http://xbnjava.aliteralmind.com}</a>, <a href="https://github.com/aliteralmind/xbnjava">{@code https://github.com/aliteralmind/xbnjava}</a>
**/
public abstract class AbstractValueAlterer<V,A> implements ValueAlterer<V,A> {
private ValueAltererComposer<V,A> avc = null;
/**
<p>Create a new instance with defaults.</p>
<p>Sets the internal composer to
<br/> {@link com.github.xbn.analyze.alter.ValueAltererComposer#ValueAltererComposer() ValueAltererComposer}<V,A>{@code ()}</p>
* @see #AbstractValueAlterer(ValueAlterer)
*/
protected AbstractValueAlterer() {
avc = new ValueAltererComposer<V,A>();
}
/**
<p>Create a new {@code AbstractAlterer} with the required setting.</p>
<p>Sets the internal composer to
<br/> {@link com.github.xbn.analyze.alter.ValueAltererComposer#ValueAltererComposer(AlterationRequired) ValueAltererComposer}<V,A>{@code (required)}</p>
* @see #AbstractValueAlterer()
* @see #AbstractValueAlterer(com.github.xbn.analyze.alter.Alterer) AbstractAlterer(a)
*/
protected AbstractValueAlterer(AlterationRequired required) {
avc = new ValueAltererComposer<V,A>(required);
}
/**
<p>Create a new {@code AbstractValueAlterer}.</p>
* @see #AbstractValueAlterer(com.github.xbn.analyze.alter.AlterationRequired)
*/
public AbstractValueAlterer(ValueAlterer<V,A> to_copy) {
avc = new ValueAltererComposer<V,A>(to_copy);
}
/**
<p>If the {@code ValueAlterer} needs to have its state reset, crash. This is useful as the first line</p>
* <p>Equal to
<br/> {@link com.github.xbn.analyze.alter.AltererComposer AltererComposer}.{@link com.github.xbn.analyze.alter.AltererComposer#autoResetStateOrCINeedTo(com.github.xbn.analyze.Analyzer) autoResetStateOrCINeedTo}{@code (this)}</p>
*/
public void autoResetStateOrCINeedTo() {
AnalyzerComposer.autoResetStateOrCINeedTo(this);
}
public String getAlteredString(V to_validate, A to_alter) {
A a = getAltered(to_validate, to_alter);
return ((a == null) ? null : a.toString());
}
public void resetState() {
avc.resetState();
}
public void resetCounts() {
avc.resetCounts();
}
public boolean wasAltered() {
return avc.wasAltered();
}
public boolean mayDelete() {
return avc.mayDelete();
}
protected void declareExpirable() {
avc.declareExpirable_4prot();
}
protected void declareExpired() {
avc.declareExpired_4prot();
}
public boolean doesExpire() {
return avc.doesExpire();
}
public boolean isExpired() {
return avc.isExpired();
}
public boolean isRequired() {
return avc.isRequired();
}
protected void declareMayDelete(boolean may_del) {
avc.declareMayDelete_4prot(may_del);
}
public int getAlteredCount() {
return avc.getAlteredCount();
}
public int getDeletedCount() {
return avc.getDeletedCount();
}
public boolean needsToBeDeleted() {
return avc.needsToBeDeleted();
}
public boolean doAutoResetState() {
return avc.doAutoResetState();
}
protected void setAutoResetState(boolean is_auto) {
avc.setAutoResetState_4prot(is_auto);
}
protected void declareAltered(Altered altered, NeedsToBeDeleted deleted) {
avc.declareAltered_4prot(altered, deleted);
}
public void resetForDeletion() {
avc.resetForDeletion();
}
public int getAnalyzedCount() {
return avc.getAnalyzedCount();
}
protected void declareAnalyzed() {
avc.declareAnalyzed_4prot();
}
public boolean wasAnalyzed() {
return avc.wasAnalyzed();
}
public void setDebug(Appendable destination, boolean is_on) {
avc.setDebug(destination, is_on);
}
public void setDebugOn(boolean is_on) {
avc.setDebugOn(is_on);
}
public boolean isDebugOn() {
return avc.isDebugOn();
}
public final Appendable getDebugApbl() {
return avc.getDebugApbl();
}
public final TextAppenter getDebugAptr() {
return avc.getDebugAptr();
}
public final TextAppenter debug(Object message) {
return avc.debug(message);
}
public final void debugln(Object message) {
avc.debugln(message);
}
public String toString() {
return appendToString(new StringBuilder()).toString();
}
public StringBuilder appendToString(StringBuilder to_appendTo) {
return avc.appendToString(to_appendTo);
}
public Object getExtraErrInfo() {
return avc.getExtraErrInfo();
}
public void setExtraErrInfo(Object info) {
avc.setExtraErrInfo(info);
}
public A getAltered(V to_validate, A to_alter) {
AltererComposer.autoResetStateOrCINeedTo(this);
return getAlteredPostResetCheck(to_validate, to_alter);
}
public RuleType getRuleType() {
return RuleType.UNRESTRICTED;
}
/**
* @return <code>{@link #appendRules(StringBuilder) appendRules}(new StringBuilder()).toString()</code>
*/
public String getRules() {
return appendRules(new StringBuilder()).toString();
}
/**
* @param to_appendTo May not be {@code null}.
* @see #getRules()
*/
public StringBuilder appendRules(StringBuilder to_appendTo) {
try {
to_appendTo.append("unrestricted");
} catch(RuntimeException rx) {
throw CrashIfObject.nullOrReturnCause(to_appendTo, "to_appendTo", null, rx);
}
return to_appendTo;
}
/**
*/
public boolean isComplete() {
return avc.isComplete();
}
/**
*/
public StringBuilder appendIncompleteInfo(StringBuilder to_appendTo) {
return avc.appendIncompleteInfo(to_appendTo);
}
protected abstract A getAlteredPostResetCheck(V to_validate, A to_alter);
public static final <V,A> A getAlteredDefensive(ValueAlterer<V,A> alterer, V to_validate, A to_alter, String alter_name, String toValidate_name, String toAlter_name) {
try {
return alterer.getAltered(to_validate, to_alter);
} catch(RuntimeException rx) {
CrashIfObject.nnull(alterer, alter_name, null);
throw new RuntimeException("Attempting " + alter_name + ".getAltered(" + toValidate_name + ", " + toAlter_name + "), " + toValidate_name + "=[" + to_validate + "], toAlter_name=[" + to_alter + "]");
}
}
/*stub functions for non-abstract compile...START
stub functions for non-abstract compile...END*/
}