inet.ipaddr.AddressSection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ipaddress Show documentation
Library for handling IP addresses, both IPv4 and IPv6
There is a newer version: 5.5.1
/*
 * Copyright 2016-2018 Sean C Foley
 *
 * 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
 *     or at
 *     https://github.com/seancfoley/IPAddress/blob/master/LICENSE
 *
 * 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 inet.ipaddr;

import java.util.Iterator;
import java.util.stream.Stream;

import inet.ipaddr.format.util.AddressComponentSpliterator;

/**
 * @author sfoley
 *
 */
public interface AddressSection extends AddressSegmentSeries {
	
	/**
	 * Determines if one section contains another.
	 * 
	 * Sections must have the same number of segments to be comparable.
	 * 

	 * For sections which are aware of their position in an address (IPv6 and MAC), their respective positions must match to be comparable.
	 * 
	 * @param other
	 * @return whether this section contains the given address section
	 */
	boolean contains(AddressSection other);
	
	/**
	 * Determines if the argument section matches this section up to the prefix length of this section.
	 * 

	 * The entire prefix of this section must be present in the other section to be comparable.  
	 * 
	 * For sections which are aware of their position in an address (IPv6 and MAC), 
	 * the argument section must have the same or an earlier position in the address to match all prefix segments of this section,
	 * and the matching is lined up relative to the position.
	 * 
	 * @param other
	 * @return whether the argument section has the same address section prefix as this
	 */
	boolean prefixEquals(AddressSection other);
	
	@Override
	AddressSection getLower();
	
	@Override
	AddressSection getUpper();
	
	@Override
	AddressSection reverseSegments();
	
	@Override
	AddressSection reverseBits(boolean perByte);
	
	@Override
	AddressSection reverseBytes();
	
	@Override
	AddressSection reverseBytesPerSegment();
	
	@Override
	AddressSection toPrefixBlock();

	@Override @Deprecated
	AddressSection removePrefixLength();
	
	@Override
	AddressSection withoutPrefixLength();
	
	@Override @Deprecated
	AddressSection removePrefixLength(boolean zeroed);

	@Override
	AddressSection adjustPrefixBySegment(boolean nextSegment);
	
	@Override
	AddressSection adjustPrefixBySegment(boolean nextSegment, boolean zeroed);

	@Override
	AddressSection adjustPrefixLength(int adjustment);

	@Override
	AddressSection adjustPrefixLength(int adjustment, boolean zeroed);

	@Override
	AddressSection setPrefixLength(int prefixLength);

	@Override
	AddressSection setPrefixLength(int prefixLength, boolean zeroed);

	@Deprecated
	@Override
	AddressSection applyPrefixLength(int networkPrefixLength);

	@Override
	Iterable getIterable();

	@Override
	Iterator iterator();
	
	@Override
	AddressComponentSpliterator spliterator();

	@Override
	Stream stream();

	@Override
	Iterator prefixIterator();
	
	@Override
	AddressComponentSpliterator prefixSpliterator();

	@Override
	public abstract Stream prefixStream();

	@Override
	Iterator prefixBlockIterator();
	
	@Override
	AddressComponentSpliterator prefixBlockSpliterator();

	@Override
	public abstract Stream prefixBlockStream();

	@Override
	AddressSection increment(long increment);

	@Override
	AddressSection incrementBoundary(long increment);
}