001    /*
002     * CDDL HEADER START
003     *
004     * The contents of this file are subject to the terms of the
005     * Common Development and Distribution License, Version 1.0 only
006     * (the "License").  You may not use this file except in compliance
007     * with the License.
008     *
009     * You can obtain a copy of the license at
010     * docs/licenses/cddl.txt
011     * or http://www.opensource.org/licenses/cddl1.php.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * docs/licenses/cddl.txt.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2013-2014 UnboundID Corp.
026     */
027    
028    package com.unboundid.directory.sdk.broker.types;
029    
030    import com.unboundid.util.ByteString;
031    import com.unboundid.util.NotExtensible;
032    
033    import java.util.Collection;
034    
035    
036    /**
037     * Container for a set of modifications to the user metadata or large metadata
038     * attributes.
039     */
040    @NotExtensible
041    public interface MetaDataMods
042    {
043      /**
044       * Get the list of values to delete. This will never be {@code null}.
045       *
046       * @return a list of ByteString values to delete from the metadata attribute
047       */
048      Collection<ByteString> getValuesToDelete();
049    
050      /**
051       * Get the list of values to add. This will never be {@code null}.
052       *
053       * @return a list of ByteString values to add to the metadata attribute
054       */
055      Collection<ByteString> getValuesToAdd();
056    
057      /**
058       * Get the number of values to add plus the number of values to delete.
059       *
060       * @return the total number of values in this modification set
061       */
062      int getTotalMods();
063    }