io.gdcc.xoai.xmlio.matchers.XmlEventMatchers Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xoai-xmlio Show documentation
Basic XML IO routines used for XOAI OAI-PMH implementation. Forked from obsolete Lyncode sources.
There is a newer version: 5.2.2
/**
 * Copyright 2012 Lyncode
 *
 * 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 io.gdcc.xoai.xmlio.matchers;

import static org.hamcrest.core.AnyOf.anyOf;

import io.gdcc.xoai.xmlio.matchers.extractor.ExtractFunction;
import io.gdcc.xoai.xmlio.matchers.extractor.MatcherExtractor;
import javax.xml.namespace.QName;
import javax.xml.stream.events.XMLEvent;
import org.hamcrest.Description;
import org.hamcrest.Matcher;
import org.hamcrest.TypeSafeMatcher;

public class XmlEventMatchers {
    public static Matcher text() {
        return new TypeSafeMatcher<>() {
            @Override
            protected boolean matchesSafely(XMLEvent item) {
                return item.isCharacters();
            }

            @Override
            public void describeTo(Description description) {
                description.appendText("is text");
            }
        };
    }

    public static Matcher aStartElement() {
        return new TypeSafeMatcher<>() {
            @Override
            protected boolean matchesSafely(XMLEvent item) {
                return item.isStartElement();
            }

            @Override
            public void describeTo(Description description) {
                description.appendText("is start element");
            }
        };
    }

    public static Matcher anEndElement() {
        return new TypeSafeMatcher<>() {
            @Override
            protected boolean matchesSafely(XMLEvent item) {
                return item.isEndElement();
            }

            @Override
            public void describeTo(Description description) {
                description.appendText("is end element");
            }
        };
    }

    public static Matcher theEndOfDocument() {
        return new TypeSafeMatcher<>() {
            @Override
            protected boolean matchesSafely(XMLEvent item) {
                return item.isEndDocument();
            }

            @Override
            public void describeTo(Description description) {
                description.appendText("is the end of the document");
            }
        };
    }

    public static Matcher theStartOfDocument() {
        return new TypeSafeMatcher<>() {
            @Override
            protected boolean matchesSafely(XMLEvent item) {
                return item.isStartDocument();
            }

            @Override
            public void describeTo(Description description) {
                description.appendText("is the start of the document");
            }
        };
    }

    public static Matcher anElement() {
        return anyOf(aStartElement(), anEndElement());
    }

    public static Matcher anElementOr(Matcher matcher) {
        return anyOf(aStartElement(), anEndElement(), matcher);
    }

    public static Matcher hasAttributes() {
        return new TypeSafeMatcher<>() {
            @Override
            protected boolean matchesSafely(XMLEvent item) {
                return aStartElement().matches(item)
                        && item.asStartElement().getAttributes().hasNext();
            }

            @Override
            public void describeTo(Description description) {
                description.appendText("has attributes");
            }
        };
    }

    public static Matcher elementName(Matcher nameMatcher) {
        return new MatcherExtractor<>(nameMatcher, extractName());
    }

    private static ExtractFunction extractName() {
        return new ExtractFunction<>() {
            @Override
            public QName apply(XMLEvent input) {
                if (input.isStartElement()) return input.asStartElement().getName();
                else if (input.isEndElement()) return input.asEndElement().getName();
                else return null;
            }

            @Override
            public void describeTo(Description description) {
                description.appendText("name");
            }
        };
    }
}