001/*
002 * #%L
003 * HAPI FHIR - Core Library
004 * %%
005 * Copyright (C) 2014 - 2025 Smile CDR, Inc.
006 * %%
007 * Licensed under the Apache License, Version 2.0 (the "License");
008 * you may not use this file except in compliance with the License.
009 * You may obtain a copy of the License at
010 *
011 * http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 * #L%
019 */
020package ca.uhn.fhir.rest.api;
021
022import ca.uhn.fhir.i18n.Msg;
023import ca.uhn.fhir.rest.server.exceptions.InvalidRequestException;
024import ca.uhn.fhir.util.UrlUtil;
025
026import java.util.HashMap;
027import java.util.Map;
028
029public enum SearchContainedModeEnum {
030
031        /**
032         * default, search on the non-contained (normal) resources
033         */
034        FALSE("false"),
035
036        /**
037         * search on the contained resources only
038         */
039        TRUE("true"),
040
041        /**
042         * Search on the normal resources and contained resources.
043         * This option is not supported yet.
044         */
045        BOTH("both");
046
047        private static volatile Map<String, SearchContainedModeEnum> ourCodeToEnum;
048        private final String myCode;
049
050        SearchContainedModeEnum(String theCode) {
051                myCode = theCode;
052        }
053
054        public String getCode() {
055                return myCode;
056        }
057
058        public static SearchContainedModeEnum fromCode(String theCode) {
059                Map<String, SearchContainedModeEnum> codeToEnum = ourCodeToEnum;
060                if (codeToEnum == null) {
061                        codeToEnum = new HashMap<>();
062                        for (SearchContainedModeEnum next : values()) {
063                                codeToEnum.put(next.getCode(), next);
064                        }
065                        ourCodeToEnum = codeToEnum;
066                }
067
068                SearchContainedModeEnum retVal = codeToEnum.get(theCode);
069                if (retVal == null) {
070                        throw new InvalidRequestException(
071                                        Msg.code(1963) + "Invalid contained mode: " + UrlUtil.sanitizeUrlPart(theCode));
072                }
073
074                return retVal;
075        }
076}