com.softlayer.api.Maskable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation

API client for accessing the SoftLayer API

There is a newer version: 0.3.4

package com.softlayer.api;

/** Interface implemented by services who accept masks for some calls */
public interface Maskable {

    /** Overwrite the existing mask on this service with a new one and return it */
    public Mask withNewMask();

    /** Use the existing mask on this service or create it if not present */
    public Mask withMask();

    /** Set the mask to the given object */
    public void setMask(Mask mask);

    /** Set the mask to a string, formatted according to http://sldn.softlayer.com/article/Object-Masks */
    public void setMask(String mask);
    
    /** Removes the mask from the service */
    public void clearMask();
}