com.smartsheet.api.internal.AbstractAssociatedResources Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smartsheet-sdk-java Show documentation

Library for connecting to Smartsheet Services

There is a newer version: 3.2.3

/*
 * Copyright (C) 2024 Smartsheet
 *
 * Licensed 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 com.smartsheet.api.internal;

import com.smartsheet.api.internal.util.Util;

/**
 * This is the base class of the Smartsheet REST API resources that are associated to other resources.
 * 
 * Thread Safety: This class is thread safe because it is immutable and its base class is thread safe.
 */
public abstract class AbstractAssociatedResources extends AbstractResources {
    /**
     * Represents the master resource type (e.g. "sheet", "workspace").
     * 
     * It will be initialized in constructor and will not change afterwards.
     */
    private String masterResourceType;

    /**
     * Constructor.
     *
     * @param smartsheet         the smartsheet
     * @param masterResourceType the master resource type
     */
    public AbstractAssociatedResources(SmartsheetImpl smartsheet, String masterResourceType) {
        super(smartsheet);
        Util.throwIfNull(masterResourceType);
        Util.throwIfEmpty(masterResourceType);

        this.masterResourceType = masterResourceType;
    }

    /**
     * Getter of corresponding field.
     *
     * @return the master resource type
     */
    protected String getMasterResourceType() {
        return masterResourceType;
    }
}