com.phloc.commons.state.IClearable Maven / Gradle / Ivy
/**
* Copyright (C) 2006-2014 phloc systems
* http://www.phloc.com
* office[at]phloc[dot]com
*
* 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.phloc.commons.state;
import javax.annotation.Nonnull;
/**
* Basic interface for the common action of resetting an objects contents to the
* initial state.
*
* @author Philip Helger
*/
public interface IClearable
{
/**
* Reset the contents of the element to the after-construction state.
*
* @return {@link EChange#CHANGED} if at least one element was cleared,
* {@link EChange#UNCHANGED} otherwise.
*/
@Nonnull
EChange clear ();
}