endorsed/src/org.apache.sis.referencing/main/org/apache/sis/referencing/internal/ReferencingTypes.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.sis.referencing.internal;

import java.util.Collection;
import java.util.function.UnaryOperator;
import org.opengis.referencing.ReferenceSystem;
import org.apache.sis.xml.bind.TypeRegistration;
import org.apache.sis.parameter.DefaultParameterValue;
import org.apache.sis.parameter.DefaultParameterValueGroup;
import org.apache.sis.referencing.AbstractIdentifiedObject;
import org.apache.sis.referencing.AbstractReferenceSystem;


/**
 * Declares the classes of objects to be marshalled using a default {@code MarshallerPool}.
 * This class is declared in {@code module-info.java} as a provider of the
 * {@code org.apache.sis.xml.bind.TypeRegistration} service.
 *
 * @author  Martin Desruisseaux (Geomatys)
 */
public final class ReferencingTypes extends TypeRegistration implements UnaryOperator<Object> {
    /**
     * Creates a default provider of additional types to register.
     */
    public ReferencingTypes() {
    }

    /**
     * Adds to the given collection the referencing types that should be given to the initial JAXB context.
     */
    @Override
    protected void getTypes(final Collection<Class<?>> addTo) {
        addTo.add(AbstractIdentifiedObject.class);
        addTo.add(DefaultParameterValue.class);
        addTo.add(DefaultParameterValueGroup.class);
    }

    /**
     * Returns the converter to apply before marshalling objects.
     *
     * @return {@code this}.
     */
    @Override
    protected UnaryOperator<Object> beforeMarshal() {
        return this;
    }

    /**
     * Ensures that the given value is an instance of a class that can be marshalled,
     * or returns {@code null} if the type is not handled by this method.
     *
     * @param  value  the value to marshal.
     * @return the given value as a type that can be marshalled, or {@code null}.
     */
    @Override
    public Object apply(final Object value) {
        return (value instanceof ReferenceSystem) ? AbstractReferenceSystem.castOrCopy((ReferenceSystem) value) : null;
    }
}