nz.net.ultraq.thymeleaf.models.extensions.ChildModelIterator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of thymeleaf-layout-dialect Show documentation

Thymeleaf Layout Dialect rewritten in java.

There is a newer version: 3.2.0

Show newest version

/*
 * Copyright 2016, Emanuel Rabina (http://www.ultraq.net.nz/)
 *
 * 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 nz.net.ultraq.thymeleaf.models.extensions;

import java.util.Iterator;
import nz.net.ultraq.thymeleaf.internal.Extensions;
import org.thymeleaf.model.IModel;

/**
 * An iterator that works with a model's immediate children, returning each one
 * as a model of its own.
 *
 * @author zhanhb
 * @author Emanuel Rabina
 */
public class ChildModelIterator implements Iterator {

    private final IModel parent;
    private int currentIndex = 1;  // Starts after the root element

    public ChildModelIterator(IModel parent) {
        this.parent = parent;
    }

    @Override
    public boolean hasNext() {
        return currentIndex < (parent.size() - 1);
    }

    /**
     * Returns the next immediate child model of this model.
     *
     * @return The next model in the iteration.
     */
    @Override
    public IModel next() {
        IModel subModel = Extensions.getModel(parent, currentIndex);
        currentIndex += subModel.size();
        return subModel;
    }

    /**
     * Not applicable for this iterator.
     *
     * @throws UnsupportedOperationException
     */
	// TODO: Not needed from Java 8 onwards - default method does this
    @Override
    public void remove() {
        throw new UnsupportedOperationException();
    }

}