001/*
002 * ============================================================================
003 * Copyright © 2002-2020 by Thomas Thrien.
004 * All Rights Reserved.
005 * ============================================================================
006 *
007 * Licensed to the public under the agreements of the GNU Lesser General Public
008 * License, version 3.0 (the "License"). You may obtain a copy of the License at
009 *
010 *      http://www.gnu.org/licenses/lgpl.html
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
014 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
015 * License for the specific language governing permissions and limitations
016 * under the License.
017 */
018
019package org.tquadrat.foundation.xml.parse;
020
021import static org.apiguardian.api.API.Status.EXPERIMENTAL;
022import static org.tquadrat.foundation.lang.Objects.requireNonNullArgument;
023
024import javax.xml.stream.Location;
025
026import org.apiguardian.api.API;
027import org.tquadrat.foundation.annotation.ClassVersion;
028import org.xml.sax.Locator;
029
030/**
031 *  An implementation of
032 *  {@link org.xml.sax.Locator}
033 *  that is based on an instance of
034 *  {@link javax.xml.stream.Location}.
035 *
036 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
037 *  @version $Id: LocationLocator.java 820 2020-12-29 20:34:22Z tquadrat $
038 *  @since 0.0.5
039 *
040 *  @UMLGraph.link
041 */
042@ClassVersion( sourceVersion = "$Id: LocationLocator.java 820 2020-12-29 20:34:22Z tquadrat $" )
043@API( status = EXPERIMENTAL, since = "0.0.5" )
044public final class LocationLocator implements Locator
045{
046        /*------------*\
047    ====** Attributes **=======================================================
048        \*------------*/
049    /**
050     *  The location that provides the data.
051     */
052    private final Location m_Location;
053
054        /*--------------*\
055    ====** Constructors **=====================================================
056        \*--------------*/
057    /**
058     *  Creates a new {@code LocationLocator} instance from the given instance
059     *  of
060     *  {@link Location}.
061     *
062     *  @param  location    The location.
063     */
064    public LocationLocator( final Location location ) { m_Location = requireNonNullArgument( location, "location" ); }
065
066        /*---------*\
067    ====** Methods **==========================================================
068        \*---------*/
069    /**
070     *  {@inheritDoc}
071     */
072    @Override
073    public final int getColumnNumber() {return m_Location.getColumnNumber(); }
074
075    /**
076     *  {@inheritDoc}
077     */
078    @Override
079    public final int getLineNumber() {return m_Location.getLineNumber(); }
080
081    /**
082     *  {@inheritDoc}
083     */
084    @Override
085    public final String getPublicId() {return m_Location.getPublicId(); }
086
087    /**
088     *  {@inheritDoc}
089     */
090    @Override
091    public final String getSystemId()  {return m_Location.getSystemId(); }
092}
093//  class LocationLocator
094
095/*
096 *  End of File
097 */