Modifier and Type	Class and Description
pack-priv static enum	PacketLineIn.AckNackResult
public static class	PacketLineIn.InputOverLimitIOException IOException thrown by read when the configured input limit is exceeded.
public static class	PacketLineIn.PacketLineInIterator Iterator over packet lines.

Modifier and Type	Field and Description
private static final String	DELIM Magic return from `readString()` when a delim packet is found.
private static final String	END Magic return from `readString()` when a flush packet is found.
private final InputStream	in
private long	limit
private final byte[]	lineBuffer
private static final Logger	log

Access	Constructor and Description
public	PacketLineIn(InputStream the input stream to consume. in) Create a new packet line reader.
public	PacketLineIn(InputStream the input stream to consume. in, long bytes to read from the input; unlimited if set to 0. limit) Create a new packet line reader.

Method Summary

Modifier and Type	Method and Description
pack-priv static String	Returns: The delimiter marker. delimiter() Get the delimiter marker.
pack-priv void	discardUntilEnd()
pack-priv static String	Returns: The end marker. end() Get the end marker.
private IOException	invalidHeader()
private IOException	invalidHeader(Throwable cause)
public static boolean	Returns: true if the given string is `DELIM`, otherwise false. isDelimiter(String the string to check s) Check if a string is the delimiter marker.
public static boolean	Returns: true if the given string is `END`, otherwise false. isEnd(String the string to check s) Check if a string is the packet end marker.
pack-priv static PacketLineIn.AckNackResult	Returns: one of `NAK`, `ACK_COMMON`, or `ACK_READY` parseACKv2(String to parse line, MutableObjectId in case of `ACK_COMMON` returnedId) Parses a ACK/NAK line in protocol V2.
pack-priv PacketLineIn.AckNackResult	readACK(MutableObjectId returnedId)
pack-priv int	readLength()
public String	Returns: the string. `END` if the string was the magic flush packet, `DELIM` if the string was the magic DELIM packet. readString() Read a single UTF-8 encoded string packet from the input stream.
public String	Returns: the string. `END` if the string was the magic flush packet. readStringRaw() Read a single UTF-8 encoded string packet from the input stream.
public PacketLineIn.PacketLineInIterator	Returns: an iterator that calls `readString()` until `END` is encountered. readStrings() Get an iterator to read strings from the input stream.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DELIM	back to summary
private static final String DELIM Magic return from `readString()` when a delim packet is found.

END	back to summary
private static final String END Magic return from `readString()` when a flush packet is found.

in	back to summary
private final InputStream in

limit	back to summary
private long limit

lineBuffer	back to summary
private final byte[] lineBuffer

log	back to summary
private static final Logger log

Constructor Detail

PacketLineIn	back to summary
public PacketLineIn(InputStream in) Create a new packet line reader. Parameters in:InputStream the input stream to consume.

PacketLineIn

back to summary

public PacketLineIn(InputStream in)

Create a new packet line reader.

Parameters

in:InputStream: the input stream to consume.

PacketLineIn	back to summary
public PacketLineIn(InputStream in, long limit) Create a new packet line reader. Parameters in:InputStream the input stream to consume. limit:long bytes to read from the input; unlimited if set to 0. Since 4.7

PacketLineIn

back to summary

public PacketLineIn(InputStream in, long limit)

Create a new packet line reader.

Parameters

in:InputStream: the input stream to consume.
limit:long: bytes to read from the input; unlimited if set to 0.

Since

4.7

Method Detail

delimiter	back to summary
pack-priv static String delimiter() Get the delimiter marker. Intended for use only in tests. Returns:String The delimiter marker.

delimiter

back to summary

pack-priv static String delimiter()

Get the delimiter marker.

Intended for use only in tests.

Returns:String: The delimiter marker.

discardUntilEnd	back to summary
pack-priv void discardUntilEnd() throws IOException

end	back to summary
pack-priv static String end() Get the end marker. Intended for use only in tests. Returns:String The end marker.

end

back to summary

pack-priv static String end()

Get the end marker.

Intended for use only in tests.

Returns:String: The end marker.

invalidHeader	back to summary
private IOException invalidHeader()

invalidHeader	back to summary
private IOException invalidHeader(Throwable cause)

isDelimiter back to summary

isDelimiter	back to summary
public static boolean isDelimiter(String s) Check if a string is the delimiter marker. Parameters s:String the string to check Returns:boolean true if the given string is `DELIM`, otherwise false. Annotations @SuppressWarnings:ReferenceEquality, StringEquality Since 5.4

public static boolean isDelimiter(String s)

Check if a string is the delimiter marker.

Parameters

s:String: the string to check

Returns:boolean

true if the given string is DELIM, otherwise false.

Annotations

@SuppressWarnings:ReferenceEquality, StringEquality

Since

5.4

isEnd back to summary

isEnd	back to summary
public static boolean isEnd(String s) Check if a string is the packet end marker. Parameters s:String the string to check Returns:boolean true if the given string is `END`, otherwise false. Annotations @SuppressWarnings:ReferenceEquality, StringEquality Since 5.4

public static boolean isEnd(String s)

Check if a string is the packet end marker.

Parameters

s:String: the string to check

Returns:boolean

true if the given string is END, otherwise false.

Annotations

@SuppressWarnings:ReferenceEquality, StringEquality

Since

5.4

parseACKv2 back to summary

parseACKv2	back to summary
pack-priv static PacketLineIn.AckNackResult parseACKv2(String line, MutableObjectId returnedId) throws IOException Parses a ACK/NAK line in protocol V2. Parameters line:String to parse returnedId:MutableObjectId in case of `ACK_COMMON` Returns:PacketLineIn.AckNackResult one of `NAK`, `ACK_COMMON`, or `ACK_READY` Exceptions IOException: on protocol or transport errors

pack-priv static PacketLineIn.AckNackResult parseACKv2(String line, MutableObjectId returnedId) throws IOException

Parses a ACK/NAK line in protocol V2.

Parameters

line:String: to parse
returnedId:MutableObjectId: in case of ACK_COMMON

Returns:PacketLineIn.AckNackResult

one of NAK, ACK_COMMON, or ACK_READY

Exceptions

IOException:: on protocol or transport errors

readACK	back to summary
pack-priv PacketLineIn.AckNackResult readACK(MutableObjectId returnedId) throws IOException

readLength	back to summary
pack-priv int readLength() throws IOException

readString back to summary

readString	back to summary
public String readString() throws IOException Read a single UTF-8 encoded string packet from the input stream. If the string ends with an LF, it will be removed before returning the value to the caller. If this automatic trimming behavior is not desired, use `readStringRaw()` instead. Returns:String the string. `END` if the string was the magic flush packet, `DELIM` if the string was the magic DELIM packet. Exceptions IOException: the stream cannot be read.

public String readString() throws IOException

Read a single UTF-8 encoded string packet from the input stream.

If the string ends with an LF, it will be removed before returning the value to the caller. If this automatic trimming behavior is not desired, use readStringRaw() instead.

Returns:String

the string. END if the string was the magic flush packet, DELIM if the string was the magic DELIM packet.

Exceptions

IOException:: the stream cannot be read.

readStringRaw back to summary

readStringRaw	back to summary
public String readStringRaw() throws IOException Read a single UTF-8 encoded string packet from the input stream. Unlike `readString()` a trailing LF will be retained. Returns:String the string. `END` if the string was the magic flush packet. Exceptions IOException: the stream cannot be read.

public String readStringRaw() throws IOException

Read a single UTF-8 encoded string packet from the input stream.

Unlike readString() a trailing LF will be retained.

Returns:String

the string. END if the string was the magic flush packet.

Exceptions

IOException:: the stream cannot be read.

readStrings back to summary

readStrings	back to summary
public PacketLineIn.PacketLineInIterator readStrings() throws IOException Get an iterator to read strings from the input stream. Returns:PacketLineIn.PacketLineInIterator an iterator that calls `readString()` until `END` is encountered. Exceptions IOException: on failure to read the initial packet line. Since 5.4

public PacketLineIn.PacketLineInIterator readStrings() throws IOException

Get an iterator to read strings from the input stream.

Returns:PacketLineIn.PacketLineInIterator

an iterator that calls readString() until END is encountered.

Exceptions

IOException:: on failure to read the initial packet line.

Since

5.4

org.eclipse.jgit.transport back to summary

pack-priv final Enum PacketLineIn.AckNackResult

Class Inheritance

extends Enum<PacketLineIn.AckNackResult>

java.lang.Object
java.lang.Enum
org.eclipse.jgit.transport.PacketLineIn.AckNackResult

Field Summary

Modifier and Type	Field and Description
public static final PacketLineIn.AckNackResult	ACK ACK
public static final PacketLineIn.AckNackResult	ACK_COMMON ACK + common
public static final PacketLineIn.AckNackResult	ACK_CONTINUE ACK + continue
public static final PacketLineIn.AckNackResult	ACK_READY ACK + ready
public static final PacketLineIn.AckNackResult	NAK NAK

Constructor Summary

Access	Constructor and Description
private	AckNackResult()

Method Summary

Modifier and Type	Method and Description
public static PacketLineIn.AckNackResult	valueOf(String name)
public static PacketLineIn.AckNackResult[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ACK	back to summary
public static final PacketLineIn.AckNackResult ACK ACK

ACK_COMMON	back to summary
public static final PacketLineIn.AckNackResult ACK_COMMON ACK + common

ACK_CONTINUE	back to summary
public static final PacketLineIn.AckNackResult ACK_CONTINUE ACK + continue

ACK_READY	back to summary
public static final PacketLineIn.AckNackResult ACK_READY ACK + ready

NAK	back to summary
public static final PacketLineIn.AckNackResult NAK NAK

Constructor Detail

AckNackResult	back to summary
private AckNackResult()

Method Detail

valueOf	back to summary
public static PacketLineIn.AckNackResult valueOf(String name)

values	back to summary
public static PacketLineIn.AckNackResult[] values()

org.eclipse.jgit.transport back to summary

public Class PacketLineIn.InputOverLimitIOException

Class Inheritance

extends IOException

java.lang.Object
java.lang.Throwable
java.lang.Exception
java.io.IOException
org.eclipse.jgit.transport.PacketLineIn.InputOverLimitIOException

IOException thrown by read when the configured input limit is exceeded.

Since: 4.7

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides java.io.IOException.serialVersionUID.

Constructor Summary

Access	Constructor and Description
public	InputOverLimitIOException()

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.io.IOException.serialVersionUID.

Constructor Detail

InputOverLimitIOException	back to summary
public InputOverLimitIOException()

org.eclipse.jgit.transport back to summary

public Class PacketLineIn.PacketLineInIterator

Class Inheritance

extends Object
implements Iterable<String>

java.lang.Object
org.eclipse.jgit.transport.PacketLineIn.PacketLineInIterator

All Implemented Interfaces

java.lang.Iterable

Iterator over packet lines.

Calls readString() on the PacketLineIn until END is encountered.

Since: 5.4

Field Summary

Modifier and Type	Field and Description
private String	current
private PacketLineIn	in

Constructor Summary

Access	Constructor and Description
pack-priv	PacketLineInIterator(PacketLineIn in)

Method Summary

Modifier and Type	Method and Description
public Iterator<String>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator over elements of type `T`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

current	back to summary
private String current

in	back to summary
private PacketLineIn in

Constructor Detail

PacketLineInIterator	back to summary
pack-priv PacketLineInIterator(PacketLineIn in) throws IOException

Method Detail

iterator back to summary

iterator	back to summary
public Iterator<String> iterator() Implements java.lang.Iterable.iterator. Doc from java.lang.Iterable.iterator. Returns an iterator over elements of type `T`. Returns:Iterator<String> an Iterator. Annotations @Override

public Iterator<String> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Returns:Iterator<String>

an Iterator.

Annotations

@Override

public Class PacketLineIn

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum PacketLineIn.AckNackResult

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class PacketLineIn.InputOverLimitIOException

Field Summary

Constructor Summary

Field Detail

Constructor Detail

public Class PacketLineIn.PacketLineInIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail