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.r4.model;
030
031/*-
032 * #%L
033 * org.hl7.fhir.r4
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;
056
057import ca.uhn.fhir.model.api.annotation.DatatypeDef;
058
059/**
060 * Primitive type "uri" in FHIR: any valid URI. Sometimes constrained to be only an absolute URI, and sometimes constrained to be a literal reference
061 */
062@DatatypeDef(name = "uri")
063public class UriType extends PrimitiveType<String> {
064
065        private static final long serialVersionUID = 3L;
066
067        /**
068         * Constructor
069         */
070        public UriType() {
071                // nothing
072        }
073
074        /**
075         * Constructor
076         */
077        public UriType(String theValue) {
078                setValueAsString(theValue);
079        }
080
081        /**
082         * Constructor
083         */
084        public UriType(URI theValue) {
085                setValue(theValue.toString());
086        }
087
088        @Override
089        public UriType copy() {
090                UriType ret = new UriType(getValue());
091    copyValues(ret);
092    return ret;
093        }
094
095        @Override
096        protected String encode(String theValue) {
097                return theValue;
098        }
099
100        /**
101         * Compares the given string to the string representation of this URI. In many cases it is preferable to use this
102         * instead of the standard {@link #equals(Object)} method, since that method returns <code>false</code> unless it is
103         * passed an instance of {@link UriType}
104         */
105        public boolean equals(String theString) {
106                return StringUtils.equals(getValueAsString(), theString);
107        }
108
109        @Override
110        public int hashCode() {
111                final int prime = 31;
112                int result = 1;
113
114                String normalize = normalize(getValue());
115                result = prime * result + ((normalize == null) ? 0 : normalize.hashCode());
116
117                return result;
118        }
119
120        private String normalize(String theValue) {
121                if (theValue == null) {
122                        return null;
123                }
124                try {
125                        URI retVal = new URI(getValue()).normalize();
126                        String urlString = retVal.toString();
127                        if (urlString.endsWith("/") && urlString.length() > 1) {
128                                retVal = new URI(urlString.substring(0, urlString.length() - 1));
129                        }
130                        return retVal.toASCIIString();
131                } catch (URISyntaxException e) {
132                        // ourLog.debug("Failed to normalize URL '{}', message was: {}", urlString, e.toString());
133                        return theValue;
134                }
135        }
136
137        @Override
138        protected String parse(String theValue) {
139                return theValue;
140        }
141
142        /**
143         * Creates a new OidType instance which uses the given OID as the content (and prepends "urn:oid:" to the OID string
144         * in the value of the newly created OidType, per the FHIR specification).
145         * 
146         * @param theOid
147         *            The OID to use (<code>null</code> is acceptable and will result in a UriDt instance with a
148         *            <code>null</code> value)
149         * @return A new UriDt instance
150         */
151        public static OidType fromOid(String theOid) {
152                if (theOid == null) {
153                        return new OidType();
154                }
155                return new OidType("urn:oid:" + theOid);
156        }
157
158         @Override
159   public boolean equalsDeep(Base obj) {
160     if (!super.equalsDeep(obj))
161       return false;
162                if (this == obj)
163                        return true;
164                if (obj == null)
165                        return false;
166                if (getClass() != obj.getClass())
167                        return false;
168
169                UriType other = (UriType) obj;
170                if (getValue() == null && other.getValue() == null) {
171                        return true;
172                }
173                if (getValue() == null || other.getValue() == null) {
174                        return false;
175                }
176
177                String normalize = normalize(getValue());
178                String normalize2 = normalize(other.getValue());
179                return normalize.equals(normalize2);
180   }
181
182                public String fhirType() {
183                        return "uri";                   
184                }
185
186}