001/*
002 * (C) Copyright 2017 Nuxeo (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Funsho David
018 *     Kevin Leturc
019 */
020package org.nuxeo.ecm.core.versioning;
021
022import java.util.function.BiPredicate;
023
024import org.nuxeo.ecm.core.api.DocumentModel;
025
026/**
027 * A versioning policy filter for automatic versioning system.
028 *
029 * @since 9.1
030 */
031public interface VersioningPolicyFilter extends BiPredicate<DocumentModel, DocumentModel> {
032
033    /**
034     * @param previousDocument the document before modification, could be null if event is aboutToCreate
035     * @param currentDocument the document after modification
036     * @return whether or not this filter matches the current context, if all policy's filters match, then apply policy
037     */
038    @Override
039    boolean test(DocumentModel previousDocument, DocumentModel currentDocument);
040
041}