001/*
002Copyright (c) 2011+, HL7, Inc
003All rights reserved.
004
005Redistribution and use in source and binary forms, with or without modification, 
006are permitted provided that the following conditions are met:
007
008 * Redistributions of source code must retain the above copyright notice, this 
009   list of conditions and the following disclaimer.
010 * Redistributions in binary form must reproduce the above copyright notice, 
011   this list of conditions and the following disclaimer in the documentation 
012   and/or other materials provided with the distribution.
013 * Neither the name of HL7 nor the names of its contributors may be used to 
014   endorse or promote products derived from this software without specific 
015   prior written permission.
016
017THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
018ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
019WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
020IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
021INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
022NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
023PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
024WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
025ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
026POSSIBILITY OF SUCH DAMAGE.
027
028*/
029package org.hl7.fhir.dstu2.model;
030
031/*-
032 * #%L
033 * org.hl7.fhir.dstu2
034 * %%
035 * Copyright (C) 2014 - 2019 Health Level 7
036 * %%
037 * Licensed under the Apache License, Version 2.0 (the "License");
038 * you may not use this file except in compliance with the License.
039 * You may obtain a copy of the License at
040 * 
041 *      http://www.apache.org/licenses/LICENSE-2.0
042 * 
043 * Unless required by applicable law or agreed to in writing, software
044 * distributed under the License is distributed on an "AS IS" BASIS,
045 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
046 * See the License for the specific language governing permissions and
047 * limitations under the License.
048 * #L%
049 */
050
051
052import java.net.URI;
053import java.net.URISyntaxException;
054
055import org.apache.commons.lang3.StringUtils;
056import ca.uhn.fhir.model.api.annotation.DatatypeDef;
057
058/**
059 * Primitive type "uri" in FHIR: any valid URI. Sometimes constrained to be only an absolute URI, and sometimes constrained to be a literal reference
060 */
061@DatatypeDef(name = "uri")
062public class UriType extends PrimitiveType<String> {
063
064        private static final long serialVersionUID = 3L;
065
066        /**
067         * Constructor
068         */
069        public UriType() {
070                // nothing
071        }
072
073        /**
074         * Constructor
075         */
076        public UriType(String theValue) {
077                setValueAsString(theValue);
078        }
079
080        /**
081         * Constructor
082         */
083        public UriType(URI theValue) {
084                setValue(theValue.toString());
085        }
086
087        @Override
088        public UriType copy() {
089                return new UriType(getValue());
090        }
091
092        @Override
093        protected String encode(String theValue) {
094                return theValue;
095        }
096
097        /**
098         * Compares the given string to the string representation of this URI. In many cases it is preferable to use this
099         * instead of the standard {@link #equals(Object)} method, since that method returns <code>false</code> unless it is
100         * passed an instance of {@link UriType}
101         */
102        public boolean equals(String theString) {
103                return StringUtils.equals(getValueAsString(), theString);
104        }
105
106        @Override
107        public int hashCode() {
108                final int prime = 31;
109                int result = 1;
110
111                String normalize = normalize(getValue());
112                result = prime * result + ((normalize == null) ? 0 : normalize.hashCode());
113
114                return result;
115        }
116
117        private String normalize(String theValue) {
118                if (theValue == null) {
119                        return null;
120                }
121                try {
122                        URI retVal = new URI(getValue()).normalize();
123                        String urlString = retVal.toString();
124                        if (urlString.endsWith("/") && urlString.length() > 1) {
125                                retVal = new URI(urlString.substring(0, urlString.length() - 1));
126                        }
127                        return retVal.toASCIIString();
128                } catch (URISyntaxException e) {
129                        // ourLog.debug("Failed to normalize URL '{}', message was: {}", urlString, e.toString());
130                        return theValue;
131                }
132        }
133
134        @Override
135        protected String parse(String theValue) {
136                return theValue;
137        }
138
139        /**
140         * Creates a new OidType instance which uses the given OID as the content (and prepends "urn:oid:" to the OID string
141         * in the value of the newly created OidType, per the FHIR specification).
142         * 
143         * @param theOid
144         *            The OID to use (<code>null</code> is acceptable and will result in a UriDt instance with a
145         *            <code>null</code> value)
146         * @return A new UriDt instance
147         */
148        public static OidType fromOid(String theOid) {
149                if (theOid == null) {
150                        return new OidType();
151                }
152                return new OidType("urn:oid:" + theOid);
153        }
154
155         @Override
156   public boolean equalsDeep(Base obj) {
157     if (!super.equalsDeep(obj))
158       return false;
159                if (this == obj)
160                        return true;
161                if (obj == null)
162                        return false;
163                if (getClass() != obj.getClass())
164                        return false;
165
166                UriType other = (UriType) obj;
167                if (getValue() == null && other.getValue() == null) {
168                        return true;
169                }
170                if (getValue() == null || other.getValue() == null) {
171                        return false;
172                }
173
174                String normalize = normalize(getValue());
175                String normalize2 = normalize(other.getValue());
176                return normalize.equals(normalize2);
177   }
178
179                public String fhirType() {
180                        return "uri";                   
181                }
182
183}