summaryrefslogtreecommitdiffstats
path: root/rosetta/src/main/java/org/onap/aaf/rosetta/Marshal.java
blob: 80e3490c87b47f87fe622c40aa29df7fa69d4526 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
/*******************************************************************************
 * ============LICENSE_START====================================================
 * * org.onap.aaf
 * * ===========================================================================
 * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
 * * ===========================================================================
 * * 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.
 * * ============LICENSE_END====================================================
 * *
 * * ECOMP is a trademark and service mark of AT&T Intellectual Property.
 * *
 ******************************************************************************/
package org.onap.aaf.rosetta;

import java.util.Iterator;

import org.onap.aaf.inno.env.Env;
import org.onap.aaf.inno.env.TimeTaken;

public abstract class Marshal<T> implements Parse<T, Marshal.State> {

	/* (non-Javadoc)
	 * @see com.att.rosetta.Parse#newParsed()
	 */
	@Override
	public Parsed<State> newParsed() throws ParseException {
		return new Parsed<State>(new State());
	}

	@Override
	public TimeTaken start(Env env) {
		//TODO is a way to mark not-JSON?
		return env.start("Rosetta Marshal", Env.JSON);
	};

	public static class State {
		// Note:  Need a STATEFUL stack... one that will remain stateful until marked as finished
		// "finished" is know by Iterators with no more to do/null
		// Thus the concept of "Ladder", which one ascends and decends
		public Ladder<Iterator<?>> ladder = new Ladder<Iterator<?>>();
		public boolean smallest = true;
	}

	public static final Iterator<Void> DONE_ITERATOR = new Iterator<Void>() {
		@Override
		public boolean hasNext() {
			return false;
		}

		@Override
		public Void next() {
			return null;
		}

		@Override
		public void remove() {
		}
	};

	/**
	 * Typical definition of Done is when Iterator in Ladder is "DONE_ITERATOR"
	 * 
	 * It is important, however, that the "Ladder Rung" is set to the right level.
	 * 
	 * @param state
	 * @return
	 */
	public boolean amFinished(State state) {
		return DONE_ITERATOR.equals(state.ladder.peek());
	}

}