blob: 3dfafbc3b364db642ee57cdcce04cc3a771ea331 [file] [log] [blame]
/*
* 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.xml.bind.gco;
import jakarta.xml.bind.annotation.XmlElement;
import jakarta.xml.bind.annotation.XmlSchemaType;
import jakarta.xml.bind.annotation.XmlType;
import org.apache.sis.metadata.AbstractMetadata;
/**
* Wraps an integer value in an {@code <gco:Integer>} element.
* The ISO 19115-3 standard requires most types to be wrapped by an element representing the value type.
* The JAXB default behavior is to marshal primitive Java types directly, without such wrapper element.
* The role of this class is to add the {@code <gco:…>} wrapper element required by ISO 19115-3.
*
* @author Cédric Briançon (Geomatys)
* @author Martin Desruisseaux (Geomatys)
*
* @see GO_Integer64
* @see GO_UnlimitedInteger
*/
@XmlType(name = "Integer_PropertyType")
public class GO_Integer extends PropertyType<GO_Integer, Integer> {
/**
* Empty constructor used only by JAXB.
*/
public GO_Integer() {
}
/**
* Builds a wrapper for the specified value, which may be nil.
*
* @param owner the metadata providing the value object.
* @param property UML identifier of the property for which a value is provided.
* @param value the property value, or {@code null} if none.
* @param mandatory whether a value is mandatory.
*/
public GO_Integer(AbstractMetadata owner, String property, Integer value, boolean mandatory) {
super(owner, property, value, mandatory);
}
/**
* Constructs a wrapper for the given value.
*
* @param value the value.
*/
private GO_Integer(final Integer value) {
super(value, false);
}
/**
* Returns the Java type which is bound by this adapter.
*
* @return {@code Integer.class}
*/
@Override
protected final Class<Integer> getBoundType() {
return Integer.class;
}
/**
* Allows JAXB to change the result of the marshalling process, according to the
* ISO 19115-3 standard and its requirements about primitive types.
*
* @param value the integer value we want to wrap in an element representing its type.
* @return a wrapper for the integer value, that is to say an integer value wrapped
* by {@code <gco:Integer>} element.
*/
@Override
protected GO_Integer wrap(final Integer value) {
return new GO_Integer(value);
}
/**
* Invoked by JAXB at marshalling time for getting the actual value to write.
*
* @return the value to be marshalled.
*/
@XmlElement(name = "Integer")
@XmlSchemaType(name = "integer")
public final Integer getElement() {
return metadata;
}
/**
* Invoked by JAXB at unmarshalling time for storing the result temporarily.
*
* @param metadata the unmarshalled value.
*/
public final void setElement(final Integer metadata) {
this.metadata = metadata;
}
/**
* Wraps the value only if marshalling ISO 19115-3 element.
* Otherwise (i.e. if marshalling a legacy ISO 19139:2007 document), omit the element.
*/
public static final class Since2014 extends GO_Integer {
/** Empty constructor used only by JAXB. */
public Since2014() {
}
/**
* Wraps the given value in an ISO 19115-3 element, unless we are marshalling an older document.
*
* @return a non-null value only if marshalling ISO 19115-3 or newer.
*/
@Override protected GO_Integer wrap(final Integer value) {
return accept2014() ? super.wrap(value) : null;
}
}
}