LdifPart.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you 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 org.apache.directory.studio.ldifparser.model;


import org.apache.directory.studio.ldifparser.LdifFormatParameters;


/**
 * An interface representing a part of a LDIF file
 * 
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
public interface LdifPart
{
    /**
     * @return The position of this part in the LDIF file
     */
    int getOffset();


    /**
     * @return The length of this part
     */
    int getLength();


    /**
     * Tells if the part is valid or not
     * 
     * @return <code>true</code> if the part is valid.
     */
    boolean isValid();


    String getInvalidString();


    String toRawString();


    String toFormattedString( LdifFormatParameters formatParameters );


    void adjustOffset( int adjust );
}