com.credibledoc.iso8583packer.navigator.Navigator Maven / Gradle / Ivy
package com.credibledoc.iso8583packer.navigator;
import com.credibledoc.iso8583packer.dump.Visualizer;
import com.credibledoc.iso8583packer.message.Msg;
import com.credibledoc.iso8583packer.message.MsgField;
import com.credibledoc.iso8583packer.message.MsgPair;
import com.credibledoc.iso8583packer.message.MsgValue;
import com.credibledoc.iso8583packer.tag.TagPacker;
import java.util.List;
/**
* This interface contains methods for navigation (jumping) in the {@link MsgField}s graph.
*
* @author Kyrylo Semenko
*/
public interface Navigator {
/**
* Find first {@link Msg} with the name.
*
* @param msgList where for search
* @param name what to search
* @param the {@link Msg} type, {@link MsgField} or {@link MsgValue}
* @return 'null' if not found
*/
T findByName(List msgList, String name);
/**
* Find {@link MsgField} with {@link Msg#getName()}.
* @param childName {@link Msg#getName()}.
* @param currentMsgField where to start search.
* @return The found {@link MsgField} or an exception will be thrown.
*/
MsgField getChildOrThrowException(String childName, MsgField currentMsgField);
/**
* Generate field name, for example 11 or 48(FFEE2E) or just 5F2A.
* @param current focused node in the object graph
* @return 'null' if name nor fieldNum is set.
*/
String generatePath(Msg current);
/**
* @param msg the field for path generation
* @return For example msg.bitmap.PAN_02(2)
*/
String getPathRecursively(Msg msg);
/**
* Find the parent recursively.
* @param msg source object graph
* @param the {@link Msg} type, {@link MsgField} or {@link MsgValue}
* @return The root node of the graph
*/
T findRoot(T msg);
/**
* @param msgField where to find.
* @return The {@link MsgField#getTagPacker()} or parent {@link MsgField#getChildrenTagPacker()} value.
*/
TagPacker getTagPacker(MsgField msgField);
/**
* Find sibling by name.
* @param siblingName the {@link Msg#getName()} value.
* @param currentMsgField where to search for a sibling.
* @return The found sibling or throw a new exception.
*/
MsgField getSiblingOrThrowException(String siblingName, MsgField currentMsgField);
/**
* Jump to msgField root and search for the first child with the same name and tag as the field from argument.
*
* @param msgField where to search
* @param msgValue what to search
* @return The found msgField or thrown an exception
*/
MsgField findByNameAndTagOrThrowException(MsgField msgField, MsgValue msgValue);
/**
* Create new {@link MsgValue} and copy {@link MsgField#getName()}, {@link MsgField#getTag()}
* and {@link MsgField#getFieldNum()} from template.
* @param msgField the template.
* @return The created {@link MsgValue}.
*/
MsgValue newFromNameAndTag(MsgField msgField);
/**
* Get {@link MsgPair#getMsgField()} and {@link MsgPair#getMsgValue()}
* and check theirs {@link Msg#getName()} and {@link Msg#getTag()} equality.
* @param msgPair the checked container.
*/
void validateSameNamesAndTags(MsgPair msgPair);
/**
* Find first {@link Msg} with the fieldNum.
*
* @param msgList where to search
* @param fieldNum what to search
* @param the {@link Msg} type, {@link MsgField} or {@link MsgValue}
* @return 'null' if not found
*/
T findByFieldNum(List msgList, Integer fieldNum);
/**
* Set service.
*
* @param visualizer the {@link Visualizer} to set.
*/
void setVisualizer(Visualizer visualizer);
/**
* Change the current place (location) of the {@link MsgValue} to the same as the {@link MsgField} place (location).
*
* @param msgField contains information about current place (location). Place is defined by name, tag and
* parent - child relationship.
* @param msgValue to be changed, the actual place in the object graph will be set as defined in the
* first argument {@link MsgField}.
*
* @return The object graph from the second parameter with changed location.
*/
MsgValue synchronizeMessageValue(MsgField msgField, MsgValue msgValue);
}